Class default

Becca is a backend cache of all notes, branches, and attributes. There's a similar frontend cache Froca, and share cache Shaca.

Constructors

constructor

new default(): default
Returns default
- Defined in apps/server/dist/becca/becca-interface.d.ts:30

Properties

allNoteSetCache

allNoteSetCache: NoteSet

attributeIndex

attributeIndex: Record<string, BAttribute[]>

Points from attribute type-name to list of attributes

attributes

attributes: Record<string, BAttribute>

branches

branches: Record<string, BBranch>

childParentToBranch

childParentToBranch: Record<string, BBranch>

etapiTokens

etapiTokens: Record<string, BEtapiToken>

loaded

loaded: boolean

notes

notes: Record<string, BNote>

options

options: Record<string, BOption>

Methods

addNote

addNote(noteId: string, note: BNote): void
Parameters
- noteId: string
- note: BNote
Returns void
- Defined in apps/server/dist/becca/becca-interface.d.ts:36

decryptProtectedNotes

decryptProtectedNotes(): void
Returns void
- Defined in apps/server/dist/becca/becca-interface.d.ts:35

dirtyNoteSetCache

dirtyNoteSetCache(): void
Should be called when the set of all non-skeleton notes changes (added/removed)

Returns void
- Defined in apps/server/dist/becca/becca-interface.d.ts:60

findAttributes

findAttributes(type: string, name: string): BAttribute[]
Parameters
- type: string
- name: string
Returns BAttribute[]
- Defined in apps/server/dist/becca/becca-interface.d.ts:33

findAttributesWithPrefix

findAttributesWithPrefix(type: string, name: string): BAttribute[]
Parameters
- type: string
- name: string
Returns BAttribute[]
- Defined in apps/server/dist/becca/becca-interface.d.ts:34

getAllNoteSet

getAllNoteSet(): NoteSet
Returns NoteSet
- Defined in apps/server/dist/becca/becca-interface.d.ts:61

getAttachment

getAttachment(attachmentId: string, opts?: AttachmentOpts): BAttachment
Parameters
- attachmentId: string
- Optionalopts: AttachmentOpts
Returns BAttachment
- Defined in apps/server/dist/becca/becca-interface.d.ts:47

getAttachmentOrThrow

getAttachmentOrThrow(attachmentId: string, opts?: AttachmentOpts): BAttachment
Parameters
- attachmentId: string
- Optionalopts: AttachmentOpts
Returns BAttachment
- Defined in apps/server/dist/becca/becca-interface.d.ts:48

getAttachments

getAttachments(attachmentIds: string[]): BAttachment[]
Parameters
- attachmentIds: string[]
Returns BAttachment[]
- Defined in apps/server/dist/becca/becca-interface.d.ts:49

getAttribute

getAttribute(attributeId: string): BAttribute
Parameters
- attributeId: string
Returns BAttribute
- Defined in apps/server/dist/becca/becca-interface.d.ts:42

getAttributeOrThrow

getAttributeOrThrow(attributeId: string): BAttribute
Parameters
- attributeId: string
Returns BAttribute
- Defined in apps/server/dist/becca/becca-interface.d.ts:43

getBlob

getBlob(entity: { blobId?: string }): BBlob
Parameters
- entity: { blobId?: string }
Returns BBlob
- Defined in apps/server/dist/becca/becca-interface.d.ts:50

getBranch

getBranch(branchId: string): BBranch
Parameters
- branchId: string
Returns BBranch
- Defined in apps/server/dist/becca/becca-interface.d.ts:40

getBranchFromChildAndParent

getBranchFromChildAndParent(childNoteId: string, parentNoteId: string): BBranch
Parameters
- childNoteId: string
- parentNoteId: string
Returns BBranch
- Defined in apps/server/dist/becca/becca-interface.d.ts:44

getBranchOrThrow

getBranchOrThrow(branchId: string): BBranch
Parameters
- branchId: string
Returns BBranch
- Defined in apps/server/dist/becca/becca-interface.d.ts:41

getEntity

getEntity<T extends AbstractBeccaEntity<T>>(
entityName: string,
entityId: string,
): AbstractBeccaEntity<T>
Type Parameters
- T extends AbstractBeccaEntity<T>
Parameters
- entityName: string
- entityId: string
Returns AbstractBeccaEntity<T>
- Defined in apps/server/dist/becca/becca-interface.d.ts:56

getEtapiToken

getEtapiToken(etapiTokenId: string): BEtapiToken
Parameters
- etapiTokenId: string
Returns BEtapiToken
- Defined in apps/server/dist/becca/becca-interface.d.ts:55

getEtapiTokens

getEtapiTokens(): BEtapiToken[]
Returns BEtapiToken[]
- Defined in apps/server/dist/becca/becca-interface.d.ts:54

getNote

getNote(noteId: string): BNote
Parameters
- noteId: string
Returns BNote
- Defined in apps/server/dist/becca/becca-interface.d.ts:37

getNoteOrThrow

getNoteOrThrow(noteId: string): BNote
Parameters
- noteId: string
Returns BNote
- Defined in apps/server/dist/becca/becca-interface.d.ts:38

getNotes

getNotes(noteIds: string[], ignoreMissing?: boolean): BNote[]
Parameters
- noteIds: string[]
- OptionalignoreMissing: boolean
Returns BNote[]
- Defined in apps/server/dist/becca/becca-interface.d.ts:39

getOption

getOption(name: string): BOption
Parameters
- name: string
Returns BOption
- Defined in apps/server/dist/becca/becca-interface.d.ts:53

getRecentNotesFromQuery

getRecentNotesFromQuery(query: string, params?: string[]): BRecentNote[]
Parameters
- query: string
- Optionalparams: string[]
Returns BRecentNote[]
- Defined in apps/server/dist/becca/becca-interface.d.ts:57

getRevision

getRevision(revisionId: string): BRevision
Parameters
- revisionId: string
Returns BRevision
- Defined in apps/server/dist/becca/becca-interface.d.ts:45

getRevisionOrThrow

getRevisionOrThrow(revisionId: string): BRevision
Parameters
- revisionId: string
Returns BRevision
- Defined in apps/server/dist/becca/becca-interface.d.ts:46

getRevisionsFromQuery

getRevisionsFromQuery(query: string, params?: string[]): BRevision[]
Parameters
- query: string
- Optionalparams: string[]
Returns BRevision[]
- Defined in apps/server/dist/becca/becca-interface.d.ts:58

getRoot

getRoot(): BNote
Returns BNote
- Defined in apps/server/dist/becca/becca-interface.d.ts:32

reset

reset(): void
Returns void
- Defined in apps/server/dist/becca/becca-interface.d.ts:31