BaseDocumentStore
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:106
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BaseDocumentStore():
BaseDocumentStore
Returns
Section titled “Returns”BaseDocumentStore
Properties
Section titled “Properties”serializer
Section titled “serializer”serializer:
Serializer<any> =jsonSerializer
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:108
Methods
Section titled “Methods”persist()
Section titled “persist()”persist(
persistPath):void
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:111
Parameters
Section titled “Parameters”persistPath
Section titled “persistPath”string = DEFAULT_PERSIST_PATH
Returns
Section titled “Returns”void
docs()
Section titled “docs()”
abstractdocs():Promise<Record<string,BaseNode<Metadata>>>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:116
Returns
Section titled “Returns”Promise<Record<string, BaseNode<Metadata>>>
addDocuments()
Section titled “addDocuments()”
abstractaddDocuments(docs,allowUpdate):Promise<void>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:118
Parameters
Section titled “Parameters”allowUpdate
Section titled “allowUpdate”boolean
Returns
Section titled “Returns”Promise<void>
getDocument()
Section titled “getDocument()”
abstractgetDocument(docId,raiseError):Promise<undefined|BaseNode<Metadata>>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:120
Parameters
Section titled “Parameters”string
raiseError
Section titled “raiseError”boolean
Returns
Section titled “Returns”Promise<undefined | BaseNode<Metadata>>
deleteDocument()
Section titled “deleteDocument()”
abstractdeleteDocument(docId,raiseError):Promise<void>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:125
Parameters
Section titled “Parameters”string
raiseError
Section titled “raiseError”boolean
Returns
Section titled “Returns”Promise<void>
documentExists()
Section titled “documentExists()”
abstractdocumentExists(docId):Promise<boolean>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:127
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
setDocumentHash()
Section titled “setDocumentHash()”
abstractsetDocumentHash(docId,docHash):Promise<void>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:130
Parameters
Section titled “Parameters”string
docHash
Section titled “docHash”string
Returns
Section titled “Returns”Promise<void>
getDocumentHash()
Section titled “getDocumentHash()”
abstractgetDocumentHash(docId):Promise<undefined|string>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:132
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<undefined | string>
getAllDocumentHashes()
Section titled “getAllDocumentHashes()”
abstractgetAllDocumentHashes():Promise<Record<string,string>>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:134
Returns
Section titled “Returns”Promise<Record<string, string>>
getAllRefDocInfo()
Section titled “getAllRefDocInfo()”
abstractgetAllRefDocInfo():Promise<undefined|Record<string,RefDocInfo>>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:137
Returns
Section titled “Returns”Promise<undefined | Record<string, RefDocInfo>>
getRefDocInfo()
Section titled “getRefDocInfo()”
abstractgetRefDocInfo(refDocId):Promise<undefined|RefDocInfo>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:139
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
Returns
Section titled “Returns”Promise<undefined | RefDocInfo>
deleteRefDoc()
Section titled “deleteRefDoc()”
abstractdeleteRefDoc(refDocId,raiseError):Promise<void>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:141
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
raiseError
Section titled “raiseError”boolean
Returns
Section titled “Returns”Promise<void>
getNodes()
Section titled “getNodes()”getNodes(
nodeIds,raiseError):Promise<BaseNode<Metadata>[]>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:144
Parameters
Section titled “Parameters”nodeIds
Section titled “nodeIds”string[]
raiseError
Section titled “raiseError”boolean = true
Returns
Section titled “Returns”getNode()
Section titled “getNode()”Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:150
Parameters
Section titled “Parameters”nodeId
Section titled “nodeId”string
raiseError
Section titled “raiseError”boolean = true
Returns
Section titled “Returns”getNodeDict()
Section titled “getNodeDict()”getNodeDict(
nodeIdDict):Promise<Record<number,BaseNode<Metadata>>>
Defined in: .build/typescript/packages/core/src/storage/doc-store/base-document-store.ts:158