Protected
_accountProtected
_cachedProtected
Optional
_lastProtected
_startedProtected
_startProtected
Readonly
moduleProtected
Readonly
supportedStatic
Readonly
allowStatic
Readonly
configStatic
Readonly
dataStatic
Readonly
defaultStatic
Readonly
defaultStatic
Readonly
defaultStatic
defaultStatic
Readonly
defaultStatic
enableStatic
Readonly
globalStatic
Readonly
globalStatic
Readonly
hashStatic
Readonly
labelsProtected
Static
privateStatic
Readonly
schemaStatic
Readonly
sequenceStatic
Readonly
uniqueStatic
Readonly
useThe database version. If not supplied via config, it defaults to 1.
The name of the object store. If not supplied via config, it defaults
to payloads
.
Protected
storeStatic
historyStatic
historyStatic
maxStatic
maxProtected
_checkProtected
_noProtected
allProtected
archivistProtected
bindOptional
account: AccountInstanceProtected
bindOptional
account: AccountInstanceProtected
bindOptional
payloads: DeepRestrictToStringKeys<{ schema: string }>[]Optional
account: AccountInstanceOptional
additionalSigners: AccountInstance[]Protected
bindOptional
payloads: DeepRestrictToStringKeys<{ schema: string }>[]Optional
account: AccountInstanceOptional
additionalSigners: AccountInstance[]Protected
bindOptional
additionalWitnesses: AccountInstance[]Optional
errors: DeepRestrictToStringKeys<Protected
clearProtected
commitProtected
deleteOptional
account: AccountInstanceProtected
deleteOptional
config: ActionConfigProtected
generateOptional
_maxDepth: numberProtected
generateProtected
getProtected
getOptional
cursor: Lowercase<string>Protected
getUses an index to get a payload by the index value, but returns the value with the primary key (from the root store)
The db instance to use
The name of the store to use
The index to use
The key to get from the index
The primary key and the payload, or undefined if not found
Protected
getProtected
getProtected
getOptional
account: AccountInstanceProtected
getOptional
_config: InsertConfigProtected
insertOptional
account: AccountInstanceProtected
insertOptional
payloads: DeepRestrictToStringKeys<{ schema: string }>[]Protected
insertOptional
config: InsertConfigProtected
isOptional
maxDepth: numberProtected
manifestOptional
maxDepth: numberOptional
_ignoreAddresses: Lowercase<string>[]Optional
maxDepth: numberProtected
moduleOptional
options: ArchivistNextOptionsProtected
nextOptional
options: ArchivistNextOptionsOptional
options: ArchivistNextOptionsOptional
account: AccountInstanceProtected
nextOptional
options: ArchivistNextOptionsOptional
_config: InsertConfigProtected
parentOptional
payloads: DeepRestrictToStringKeys<{ schema: string }>[]Optional
queryConfig: TConfigOptional
payloads: DeepRestrictToStringKeys<{ schema: string }>[]Optional
queryConfig: TConfigProtected
queryOptional
queryConfig: TConfigOptional
options: ModuleFilterOptions<T>Optional
options: ModuleFilterOptions<T>Optional
options: ModuleFilterOptions<T>Optional
filter: ModuleFilterOptional
options: ModuleFilterOptions<T>Protected
resolveOptional
options: ObjectFilterOptionsOptional
options: ModuleFilterOptions<T>Optional
options: ModuleFilterOptions<T>Protected
sendOptional
payloads: P[]Optional
account: AccountInstanceProtected
sendOptional
payloads: P[]Optional
account: AccountInstanceProtected
startProtected
stateProtected
stopProtected
storeOptional
_queryAccount: AccountInstanceProtected
subscribeProtected
validateProtected
writeProtected
writeStatic
_getStatic
_noStatic
createStatic
determineStatic
factoryStatic
gcStatic
instanceStatic
instanceStatic
startStatic
stop
The database name. If not supplied via config, it defaults to the module name (not guaranteed to be unique) and if module name is not supplied, it defaults to
archivist
. This behavior biases towards a single, isolated DB per archivist which seems to make the most sense for 99% of use cases.