npm - @xyo-network/archivist-firebase - Versions diffs - 5.3.29 → 5.4.0 - Mend

@xyo-network/archivist-firebase 5.3.29 → 5.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md +0 -3713
package/dist/browser/Archivist.d.ts +4 -4
package/dist/browser/Archivist.d.ts.map +1 -1
package/dist/browser/index.mjs +1 -4
package/dist/browser/index.mjs.map +1 -1
package/package.json +36 -40

package/README.md CHANGED Viewed

@@ -38,3719 +38,6 @@ bun add {{name}}
 See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
-## Reference
-### packages
-  ### modules
-    ### packages
-      ### archivist
-        ### packages
-          ### firebase
-            ### .temp-typedoc
-              ### classes
-                ### <a id="FirebaseArchivist"></a>FirebaseArchivist
-[**@xyo-network/archivist-firebase**](#../README)
-***
-## Extends
-- `AbstractArchivist`\<`TParams`, `TEventData`\>
-## Type Parameters
-### TParams
-`TParams` *extends* [`FirebaseArchivistParams`](#../interfaces/FirebaseArchivistParams) = [`FirebaseArchivistParams`](#../interfaces/FirebaseArchivistParams)
-### TEventData
-`TEventData` *extends* `ArchivistModuleEventData` = `ArchivistModuleEventData`
-## Constructors
-### Constructor
-```ts
-new FirebaseArchivist<TParams, TEventData>(key, params): FirebaseArchivist<TParams, TEventData>;
-```
-### Parameters
-#### key
-`unknown`
-#### params
-`Partial`\<`TParams` & `RequiredCreatableParams`\>
-### Returns
-`FirebaseArchivist`\<`TParams`, `TEventData`\>
-### Inherited from
-```ts
-AbstractArchivist<TParams, TEventData>.constructor
-```
-## Properties
-### uniqueName
-```ts
-readonly static uniqueName: string;
-```
-### Inherited from
-```ts
-AbstractArchivist.uniqueName
-```
-***
-### defaultNextLimitSetting
-```ts
-protected static defaultNextLimitSetting: number;
-```
-### Inherited from
-```ts
-AbstractArchivist.defaultNextLimitSetting
-```
-***
-### configSchemas
-```ts
-readonly static configSchemas: Schema[];
-```
-### Overrides
-```ts
-AbstractArchivist.configSchemas
-```
-***
-### defaultConfigSchema
-```ts
-readonly static defaultConfigSchema: Schema = FirebaseArchivistConfigSchema;
-```
-### Overrides
-```ts
-AbstractArchivist.defaultConfigSchema
-```
-***
-### labels
-```ts
-readonly static labels: object;
-```
-#### network.xyo.storage.class
-```ts
-network.xyo.storage.class: string = 'network';
-```
-### Overrides
-```ts
-AbstractArchivist.labels
-```
-***
-### allowRandomAccount
-```ts
-readonly static allowRandomAccount: boolean;
-```
-### Inherited from
-```ts
-AbstractArchivist.allowRandomAccount
-```
-***
-### defaultLogger
-```ts
-static defaultLogger: Logger;
-```
-### Inherited from
-```ts
-AbstractArchivist.defaultLogger
-```
-***
-### enableLazyLoad
-```ts
-static enableLazyLoad: boolean;
-```
-### Inherited from
-```ts
-AbstractArchivist.enableLazyLoad
-```
-***
-### privateConstructorKey
-```ts
-protected static privateConstructorKey: string;
-```
-### Inherited from
-```ts
-AbstractArchivist.privateConstructorKey
-```
-***
-### \_account
-```ts
-protected _account: AccountInstance | undefined;
-```
-### Inherited from
-```ts
-AbstractArchivist._account
-```
-***
-### \_cachedManifests
-```ts
-protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;
-```
-### Inherited from
-```ts
-AbstractArchivist._cachedManifests
-```
-***
-### \_globalReentrancyMutex
-```ts
-protected _globalReentrancyMutex: Mutex | undefined;
-```
-### Inherited from
-```ts
-AbstractArchivist._globalReentrancyMutex
-```
-***
-### \_lastError?
-```ts
-protected optional _lastError?: ModuleDetailsError;
-```
-### Inherited from
-```ts
-AbstractArchivist._lastError
-```
-***
-### \_moduleConfigQueryValidator
-```ts
-protected _moduleConfigQueryValidator: Queryable | undefined;
-```
-### Inherited from
-```ts
-AbstractArchivist._moduleConfigQueryValidator
-```
-***
-### \_supportedQueryValidator
-```ts
-protected _supportedQueryValidator: Queryable | undefined;
-```
-### Inherited from
-```ts
-AbstractArchivist._supportedQueryValidator
-```
-***
-### useNewResolver
-```ts
-readonly static useNewResolver: false = false;
-```
-### Inherited from
-```ts
-AbstractArchivist.useNewResolver
-```
-## Accessors
-### defaultNextLimit
-### Get Signature
-```ts
-get static defaultNextLimit(): number;
-```
-#### Returns
-`number`
-### Inherited from
-```ts
-AbstractArchivist.defaultNextLimit
-```
-***
-### requireAllParents
-### Get Signature
-```ts
-get requireAllParents(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractArchivist.requireAllParents
-```
-***
-### payloadCountGauge
-### Get Signature
-```ts
-get protected payloadCountGauge(): Gauge<Attributes> | null | undefined;
-```
-#### Returns
-`Gauge`\<`Attributes`\> \| `null` \| `undefined`
-### Inherited from
-```ts
-AbstractArchivist.payloadCountGauge
-```
-***
-### payloadCountMeter
-### Get Signature
-```ts
-get protected payloadCountMeter(): Meter | null;
-```
-#### Returns
-`Meter` \| `null`
-### Inherited from
-```ts
-AbstractArchivist.payloadCountMeter
-```
-***
-### storeParentReads
-### Get Signature
-```ts
-get protected storeParentReads(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractArchivist.storeParentReads
-```
-***
-### queries
-### Get Signature
-```ts
-get queries(): Schema[];
-```
-#### Returns
-`Schema`[]
-### Overrides
-```ts
-AbstractArchivist.queries
-```
-***
-### account
-### Get Signature
-```ts
-get account(): AccountInstance;
-```
-#### Returns
-`AccountInstance`
-### Inherited from
-```ts
-AbstractArchivist.account
-```
-***
-### additionalSigners
-### Get Signature
-```ts
-get additionalSigners(): AccountInstance[];
-```
-#### Returns
-`AccountInstance`[]
-### Inherited from
-```ts
-AbstractArchivist.additionalSigners
-```
-***
-### address
-### Get Signature
-```ts
-get address(): Lowercase<string> & object & object;
-```
-#### Returns
-`Lowercase`\<`string`\> & `object` & `object`
-### Inherited from
-```ts
-AbstractArchivist.address
-```
-***
-### allowAnonymous
-### Get Signature
-```ts
-get allowAnonymous(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractArchivist.allowAnonymous
-```
-***
-### allowNameResolution
-### Get Signature
-```ts
-get allowNameResolution(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractArchivist.allowNameResolution
-```
-***
-### archiving
-### Get Signature
-```ts
-get archiving():
-  | {
-  archivists?: ModuleIdentifier[];
-  queries?: Schema[];
-}
-  | undefined;
-```
-#### Returns
-  \| \{
-  `archivists?`: `ModuleIdentifier`[];
-  `queries?`: `Schema`[];
-\}
-  \| `undefined`
-### Inherited from
-```ts
-AbstractArchivist.archiving
-```
-***
-### archivist
-### Get Signature
-```ts
-get archivist(): ModuleIdentifier | undefined;
-```
-#### Returns
-`ModuleIdentifier` \| `undefined`
-### Inherited from
-```ts
-AbstractArchivist.archivist
-```
-***
-### config
-### Get Signature
-```ts
-get config(): TParams["config"] & object;
-```
-#### Returns
-`TParams`\[`"config"`\] & `object`
-### Inherited from
-```ts
-AbstractArchivist.config
-```
-***
-### dead
-### Get Signature
-```ts
-get dead(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractArchivist.dead
-```
-***
-### ephemeralQueryAccountEnabled
-### Get Signature
-```ts
-get ephemeralQueryAccountEnabled(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractArchivist.ephemeralQueryAccountEnabled
-```
-***
-### globalReentrancyMutex
-### Get Signature
-```ts
-get globalReentrancyMutex(): Mutex | undefined;
-```
-#### Returns
-`Mutex` \| `undefined`
-### Inherited from
-```ts
-AbstractArchivist.globalReentrancyMutex
-```
-***
-### id
-### Get Signature
-```ts
-get id(): string;
-```
-The name (if specified) or address of the module
-#### Returns
-`string`
-### Inherited from
-```ts
-AbstractArchivist.id
-```
-***
-### logger
-### Get Signature
-```ts
-get logger(): Logger | undefined;
-```
-#### Returns
-`Logger` \| `undefined`
-### Inherited from
-```ts
-AbstractArchivist.logger
-```
-***
-### priority
-### Get Signature
-```ts
-get priority(): 2;
-```
-#### Returns
-`2`
-### Inherited from
-```ts
-AbstractArchivist.priority
-```
-***
-### reentrancy
-### Get Signature
-```ts
-get reentrancy():
-  | {
-  action: "skip" | "wait";
-  scope: "global";
-}
-  | undefined;
-```
-#### Returns
-  \| \{
-  `action`: `"skip"` \| `"wait"`;
-  `scope`: `"global"`;
-\}
-  \| `undefined`
-### Inherited from
-```ts
-AbstractArchivist.reentrancy
-```
-***
-### statusReporter
-### Get Signature
-```ts
-get statusReporter():
-  | ModuleStatusReporter & CreatableStatusReporter<void>
-  | undefined;
-```
-The status reporter used to broadcast lifecycle changes.
-#### Returns
-  \| `ModuleStatusReporter` & `CreatableStatusReporter`\<`void`\>
-  \| `undefined`
-### Inherited from
-```ts
-AbstractArchivist.statusReporter
-```
-***
-### timestamp
-### Get Signature
-```ts
-get timestamp(): boolean;
-```
-#### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractArchivist.timestamp
-```
-***
-### moduleConfigQueryValidator
-### Get Signature
-```ts
-get protected moduleConfigQueryValidator(): Queryable;
-```
-#### Returns
-`Queryable`
-### Inherited from
-```ts
-AbstractArchivist.moduleConfigQueryValidator
-```
-***
-### supportedQueryValidator
-### Get Signature
-```ts
-get protected supportedQueryValidator(): Queryable;
-```
-#### Returns
-`Queryable`
-### Inherited from
-```ts
-AbstractArchivist.supportedQueryValidator
-```
-***
-### downResolver
-### Get Signature
-```ts
-get downResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
-```
-#### Returns
-`CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
-### Inherited from
-```ts
-AbstractArchivist.downResolver
-```
-***
-### modName
-### Get Signature
-```ts
-get modName(): string | undefined;
-```
-#### Returns
-`string` \| `undefined`
-### Inherited from
-```ts
-AbstractArchivist.modName
-```
-***
-### moduleIdentifierTransformers
-### Get Signature
-```ts
-get moduleIdentifierTransformers(): ModuleIdentifierTransformer[];
-```
-#### Returns
-`ModuleIdentifierTransformer`[]
-### Inherited from
-```ts
-AbstractArchivist.moduleIdentifierTransformers
-```
-***
-### privateResolver
-### Get Signature
-```ts
-get privateResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
-```
-#### Returns
-`CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
-### Inherited from
-```ts
-AbstractArchivist.privateResolver
-```
-***
-### root
-### Get Signature
-```ts
-get root(): this;
-```
-#### Returns
-`this`
-### Inherited from
-```ts
-AbstractArchivist.root
-```
-***
-### timeBudget
-### Get Signature
-```ts
-get timeBudget(): number | undefined;
-```
-#### Returns
-`number` \| `undefined`
-### Inherited from
-```ts
-AbstractArchivist.timeBudget
-```
-***
-### upResolver
-### Get Signature
-```ts
-get upResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;
-```
-#### Returns
-`CompositeModuleResolver`\<`CompositeModuleResolverParams`\>
-### Inherited from
-```ts
-AbstractArchivist.upResolver
-```
-## Methods
-### ~~all()~~
-```ts
-all(): Promise<WithStorageMeta<Payload>[]>;
-```
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Deprecated
-use next or snapshot instead
-### Inherited from
-```ts
-AbstractArchivist.all
-```
-***
-### allQuery()
-```ts
-allQuery(account): Promise<ModuleQueryResult>;
-```
-deprecated use nextQuery or snapshotQuery instead
-### Parameters
-#### account
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractArchivist.allQuery
-```
-***
-### clear()
-```ts
-clear(): Promise<void>;
-```
-### Returns
-`Promise`\<`void`\>
-### Inherited from
-```ts
-AbstractArchivist.clear
-```
-***
-### clearQuery()
-```ts
-clearQuery(account): Promise<ModuleQueryResult>;
-```
-### Parameters
-#### account
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractArchivist.clearQuery
-```
-***
-### commit()
-```ts
-commit(): Promise<object[]>;
-```
-### Returns
-`Promise`\<`object`[]\>
-### Inherited from
-```ts
-AbstractArchivist.commit
-```
-***
-### commitQuery()
-```ts
-commitQuery(account): Promise<ModuleQueryResult>;
-```
-### Parameters
-#### account
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractArchivist.commitQuery
-```
-***
-### delete()
-```ts
-delete(hashes): Promise<WithStorageMeta<Payload>[]>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.delete
-```
-***
-### deleteQuery()
-```ts
-deleteQuery(hashes, account?): Promise<ModuleQueryResult>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractArchivist.deleteQuery
-```
-***
-### get()
-```ts
-get(hashes): Promise<WithStorageMeta<Payload>[]>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.get
-```
-***
-### getQuery()
-```ts
-getQuery(hashes, account?): Promise<ModuleQueryResult>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractArchivist.getQuery
-```
-***
-### insert()
-```ts
-insert(payloads): Promise<WithStorageMeta<Payload>[]>;
-```
-### Parameters
-#### payloads
-`Payload`[]
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.insert
-```
-***
-### insertQuery()
-```ts
-insertQuery(payloads, account?): Promise<ModuleQueryResult>;
-```
-### Parameters
-#### payloads
-`Payload`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractArchivist.insertQuery
-```
-***
-### next()
-```ts
-next(options?): Promise<WithStorageMeta<Payload>[]>;
-```
-### Parameters
-#### options?
-`ArchivistNextOptions`
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.next
-```
-***
-### nextQuery()
-```ts
-nextQuery(options?, account?): Promise<ModuleQueryResult>;
-```
-### Parameters
-#### options?
-`ArchivistNextOptions`
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractArchivist.nextQuery
-```
-***
-### snapshot()
-```ts
-snapshot(): Promise<ArchivistSnapshotPayload<WithStorageMeta<Payload>, BrandedHash>[]>;
-```
-### Returns
-`Promise`\<`ArchivistSnapshotPayload`\<`WithStorageMeta`\<`Payload`\>, `BrandedHash`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.snapshot
-```
-***
-### snapshotQuery()
-```ts
-snapshotQuery(account?): Promise<ModuleQueryResult>;
-```
-### Parameters
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractArchivist.snapshotQuery
-```
-***
-### allHandler()
-```ts
-protected allHandler(): PromisableArray<WithStorageMeta<Payload>>;
-```
-### Returns
-`PromisableArray`\<`WithStorageMeta`\<`Payload`\>\>
-### Inherited from
-```ts
-AbstractArchivist.allHandler
-```
-***
-### clearHandler()
-```ts
-protected clearHandler(): Promisable<void>;
-```
-### Returns
-`Promisable`\<`void`\>
-### Inherited from
-```ts
-AbstractArchivist.clearHandler
-```
-***
-### commitHandler()
-```ts
-protected commitHandler(): Promisable<object[]>;
-```
-### Returns
-`Promisable`\<`object`[]\>
-### Inherited from
-```ts
-AbstractArchivist.commitHandler
-```
-***
-### deleteHandler()
-```ts
-protected deleteHandler(_hashes): PromisableArray<WithStorageMeta<Payload>>;
-```
-### Parameters
-#### \_hashes
-`BrandedHash`[]
-### Returns
-`PromisableArray`\<`WithStorageMeta`\<`Payload`\>\>
-### Inherited from
-```ts
-AbstractArchivist.deleteHandler
-```
-***
-### deleteWithConfig()
-```ts
-protected deleteWithConfig(hashes, config?): Promise<WithStorageMeta<Payload>[]>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-#### config?
-`ActionConfig`
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.deleteWithConfig
-```
-***
-### generateStats()
-```ts
-protected generateStats(): Promisable<ArchivistStatsPayload>;
-```
-### Returns
-`Promisable`\<`ArchivistStatsPayload`\>
-### Inherited from
-```ts
-AbstractArchivist.generateStats
-```
-***
-### getFromParent()
-```ts
-protected getFromParent(hashes, archivist): Promise<[WithStorageMeta<Payload>[], BrandedHash[]]>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-#### archivist
-`ReadArchivist`
-### Returns
-`Promise`\<\[`WithStorageMeta`\<`Payload`\>[], `BrandedHash`[]\]\>
-### Inherited from
-```ts
-AbstractArchivist.getFromParent
-```
-***
-### getFromParents()
-```ts
-protected getFromParents(hashes): Promise<[WithStorageMeta<Payload>[], BrandedHash[]]>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-### Returns
-`Promise`\<\[`WithStorageMeta`\<`Payload`\>[], `BrandedHash`[]\]\>
-### Inherited from
-```ts
-AbstractArchivist.getFromParents
-```
-***
-### getWithConfig()
-```ts
-protected getWithConfig(hashes, _config?): Promise<WithStorageMeta<Payload>[]>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-#### \_config?
-`InsertConfig`
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.getWithConfig
-```
-***
-### insertQueryHandler()
-```ts
-protected insertQueryHandler<T>(query, payloads?): Promise<WithStorageMeta<Payload>[]>;
-```
-### Type Parameters
-#### T
-`T` *extends* `QueryBoundWitnessWrapper`\<`Query`\> = `QueryBoundWitnessWrapper`\<`Query`\>
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.insertQueryHandler
-```
-***
-### insertWithConfig()
-```ts
-protected insertWithConfig(payloads, config?): Promise<WithStorageMeta<Payload>[]>;
-```
-### Parameters
-#### payloads
-`Payload`[]
-#### config?
-`InsertConfig`
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.insertWithConfig
-```
-***
-### nextHandler()
-```ts
-protected nextHandler(_options?): Promisable<WithStorageMeta<Payload>[]>;
-```
-### Parameters
-#### \_options?
-`ArchivistNextOptions`
-### Returns
-`Promisable`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.nextHandler
-```
-***
-### nextWithConfig()
-```ts
-protected nextWithConfig(options?, _config?): Promise<WithStorageMeta<Payload>[]>;
-```
-### Parameters
-#### options?
-`ArchivistNextOptions`
-#### \_config?
-`InsertConfig`
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.nextWithConfig
-```
-***
-### parentArchivists()
-```ts
-protected parentArchivists(): Promise<ArchivistParentInstanceMap>;
-```
-### Returns
-`Promise`\<`ArchivistParentInstanceMap`\>
-### Inherited from
-```ts
-AbstractArchivist.parentArchivists
-```
-***
-### payloadCountHandler()
-```ts
-protected payloadCountHandler(): number;
-```
-### Returns
-`number`
-### Inherited from
-```ts
-AbstractArchivist.payloadCountHandler
-```
-***
-### queryHandler()
-```ts
-protected queryHandler<T, TConfig>(
-   query,
-   payloads,
-queryConfig?): Promise<ModuleQueryHandlerResult>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConfig
-`TConfig` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads
-`Payload`[]
-#### queryConfig?
-`TConfig`
-### Returns
-`Promise`\<`ModuleQueryHandlerResult`\>
-### Inherited from
-```ts
-AbstractArchivist.queryHandler
-```
-***
-### reportPayloadCount()
-```ts
-protected reportPayloadCount(): void;
-```
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractArchivist.reportPayloadCount
-```
-***
-### snapshotHandler()
-```ts
-protected snapshotHandler(): PromisableArray<ArchivistSnapshotPayload<WithStorageMeta<Payload>, BrandedHash>>;
-```
-### Returns
-`PromisableArray`\<`ArchivistSnapshotPayload`\<`WithStorageMeta`\<`Payload`\>, `BrandedHash`\>\>
-### Inherited from
-```ts
-AbstractArchivist.snapshotHandler
-```
-***
-### startHandler()
-```ts
-protected startHandler(): Promise<void>;
-```
-### Returns
-`Promise`\<`void`\>
-### Inherited from
-```ts
-AbstractArchivist.startHandler
-```
-***
-### stateHandler()
-```ts
-protected stateHandler(): Promise<Payload[]>;
-```
-### Returns
-`Promise`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractArchivist.stateHandler
-```
-***
-### writeToParent()
-```ts
-protected writeToParent(parent, payloads): Promise<Payload[]>;
-```
-### Parameters
-#### parent
-`ArchivistInstance`
-#### payloads
-`Payload`[]
-### Returns
-`Promise`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractArchivist.writeToParent
-```
-***
-### writeToParents()
-```ts
-protected writeToParents(payloads): Promise<Payload[]>;
-```
-### Parameters
-#### payloads
-`Payload`[]
-### Returns
-`Promise`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractArchivist.writeToParents
-```
-***
-### getHandler()
-```ts
-protected getHandler(hashes): Promise<WithStorageMeta<Payload>[]>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Overrides
-```ts
-AbstractArchivist.getHandler
-```
-***
-### insertHandler()
-```ts
-protected insertHandler(payloads): Promise<WithStorageMeta<Payload>[]>;
-```
-### Parameters
-#### payloads
-`WithStorageMeta`\<`Payload`\>[]
-### Returns
-`Promise`\<`WithStorageMeta`\<`Payload`\>[]\>
-### Overrides
-```ts
-AbstractArchivist.insertHandler
-```
-***
-### \_getRootFunction()
-```ts
-static _getRootFunction(funcName): any;
-```
-### Parameters
-#### funcName
-`string`
-### Returns
-`any`
-### Inherited from
-```ts
-AbstractArchivist._getRootFunction
-```
-***
-### \_noOverride()
-```ts
-static _noOverride(functionName): void;
-```
-### Parameters
-#### functionName
-`string`
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractArchivist._noOverride
-```
-***
-### createHandler()
-```ts
-static createHandler<T>(inInstance): Promise<T & AbstractModule<any, any>>;
-```
-Static hook called during creation to perform additional initialization.
-Override in subclasses to customize post-construction setup.
-### Type Parameters
-#### T
-`T` *extends* `CreatableInstance`\<`CreatableParams`, `EventData`\>
-### Parameters
-#### inInstance
-`T`
-### Returns
-`Promise`\<`T` & `AbstractModule`\<`any`, `any`\>\>
-The instance, potentially modified
-### Inherited from
-```ts
-AbstractArchivist.createHandler
-```
-***
-### determineAccount()
-```ts
-static determineAccount(params): Promise<AccountInstance>;
-```
-### Parameters
-#### params
-##### account?
-`AccountInstance` \| `"random"`
-##### accountPath?
-`string`
-##### wallet?
-`WalletInstance`
-### Returns
-`Promise`\<`AccountInstance`\>
-### Inherited from
-```ts
-AbstractArchivist.determineAccount
-```
-***
-### factory()
-```ts
-static factory<TModule>(this, params?): CreatableModuleFactory<TModule>;
-```
-### Type Parameters
-#### TModule
-`TModule` *extends* `CreatableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-### Parameters
-#### this
-`CreatableModule`\<`TModule`\>
-#### params?
-`Partial`\<`TModule`\[`"params"`\]\>
-### Returns
-`CreatableModuleFactory`\<`TModule`\>
-### Inherited from
-```ts
-AbstractArchivist.factory
-```
-***
-### isAllowedSchema()
-```ts
-static isAllowedSchema(schema): boolean;
-```
-### Parameters
-#### schema
-`Schema`
-### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractArchivist.isAllowedSchema
-```
-***
-### paramsHandler()
-```ts
-static paramsHandler<T>(inParams?): Promise<T["params"]>;
-```
-Static hook called during creation to validate and transform params.
-Override in subclasses to add default values or validation.
-### Type Parameters
-#### T
-`T` *extends* `AttachableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-### Parameters
-#### inParams?
-`Partial`\<`T`\[`"params"`\]\>
-### Returns
-`Promise`\<`T`\[`"params"`\]\>
-The processed params ready for construction
-### Inherited from
-```ts
-AbstractArchivist.paramsHandler
-```
-***
-### \_getRootFunction()
-```ts
-_getRootFunction(funcName): any;
-```
-### Parameters
-#### funcName
-`string`
-### Returns
-`any`
-### Inherited from
-```ts
-AbstractArchivist._getRootFunction
-```
-***
-### busy()
-```ts
-busy<R>(closure): Promise<R>;
-```
-### Type Parameters
-#### R
-`R`
-### Parameters
-#### closure
-() => `Promise`\<`R`\>
-### Returns
-`Promise`\<`R`\>
-### Inherited from
-```ts
-AbstractArchivist.busy
-```
-***
-### emit()
-```ts
-emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
-```
-Emits an event, invoking all registered listeners concurrently.
-### Type Parameters
-#### TEventName
-`TEventName` *extends* `string` \| `number` \| `symbol` = keyof `TEventData`
-#### TEventArgs
-`TEventArgs` *extends* `EventArgs` = `TEventData`\[`TEventName`\]
-### Parameters
-#### eventName
-`TEventName`
-The event to emit.
-#### eventArgs
-`TEventArgs`
-The data to pass to listeners.
-### Returns
-`Promise`\<`void`\>
-### Inherited from
-```ts
-AbstractArchivist.emit
-```
-***
-### isSupportedQuery()
-```ts
-isSupportedQuery(query, assert?): boolean;
-```
-### Parameters
-#### query
-`Schema`
-#### assert?
-`string` \| `boolean`
-### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractArchivist.isSupportedQuery
-```
-***
-### previousHash()
-```ts
-previousHash(): Promisable<string | undefined>;
-```
-### Returns
-`Promisable`\<`string` \| `undefined`\>
-### Inherited from
-```ts
-AbstractArchivist.previousHash
-```
-***
-### query()
-```ts
-query<T, TConfig>(
-   query,
-   payloads?,
-queryConfig?): Promise<ModuleQueryResult>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConfig
-`TConfig` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### queryConfig?
-`TConfig`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractArchivist.query
-```
-***
-### queryable()
-```ts
-queryable<T, TConfig>(
-   query,
-   payloads?,
-queryConfig?): Promise<boolean>;
-```
-### Type Parameters
-#### T
-`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
-#### TConfig
-`TConfig` *extends* `ModuleConfig` = `ModuleConfig`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### queryConfig?
-`TConfig`
-### Returns
-`Promise`\<`boolean`\>
-### Inherited from
-```ts
-AbstractArchivist.queryable
-```
-***
-### \_checkDead()
-```ts
-protected _checkDead(): void;
-```
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractArchivist._checkDead
-```
-***
-### archivistInstance()
-### Call Signature
-```ts
-protected archivistInstance(): Promise<
-  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
-| undefined>;
-```
-#### Returns
-`Promise`\<
-  \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
-  \| `undefined`\>
-#### Inherited from
-```ts
-AbstractArchivist.archivistInstance
-```
-### Call Signature
-```ts
-protected archivistInstance(required): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>;
-```
-#### Parameters
-##### required
-`true`
-#### Returns
-`Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>\>
-#### Inherited from
-```ts
-AbstractArchivist.archivistInstance
-```
-***
-### bindHashes()
-```ts
-protected bindHashes(
-   hashes,
-   schema,
-account?): PromiseEx<unknown, AccountInstance>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-#### schema
-`Schema`[]
-#### account?
-`AccountInstance`
-### Returns
-`PromiseEx`\<`unknown`, `AccountInstance`\>
-### Inherited from
-```ts
-AbstractArchivist.bindHashes
-```
-***
-### bindHashesInternal()
-```ts
-protected bindHashesInternal(
-   hashes,
-   schema,
-   account?): Promise<{
-  schema: "network.xyo.boundwitness" & object;
-  addresses: Lowercase<string> & object & object[];
-  payload_hashes: BrandedHash[];
-  payload_schemas: BrandedSchema<string>[];
-  previous_hashes: (BrandedHash | null)[];
-  $destination?: Lowercase<string> & object & object;
-  $sourceQuery?: BrandedHash;
-  $signatures: (BrandedHex | null)[];
-}>;
-```
-### Parameters
-#### hashes
-`BrandedHash`[]
-#### schema
-`Schema`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<\{
-  `schema`: `"network.xyo.boundwitness"` & `object`;
-  `addresses`: `Lowercase`\<`string`\> & `object` & `object`[];
-  `payload_hashes`: `BrandedHash`[];
-  `payload_schemas`: `BrandedSchema`\<`string`\>[];
-  `previous_hashes`: (`BrandedHash` \| `null`)[];
-  `$destination?`: `Lowercase`\<`string`\> & `object` & `object`;
-  `$sourceQuery?`: `BrandedHash`;
-  `$signatures`: (`BrandedHex` \| `null`)[];
-\}\>
-### Inherited from
-```ts
-AbstractArchivist.bindHashesInternal
-```
-***
-### bindQuery()
-```ts
-protected bindQuery<T>(
-   query,
-   payloads?,
-   account?,
-additionalSigners?): PromiseEx<[UnsignedQueryBoundWitness, Payload[], Payload[]], AccountInstance>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### account?
-`AccountInstance`
-#### additionalSigners?
-`AccountInstance`[]
-### Returns
-`PromiseEx`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\], `AccountInstance`\>
-### Inherited from
-```ts
-AbstractArchivist.bindQuery
-```
-***
-### bindQueryInternal()
-```ts
-protected bindQueryInternal<T>(
-   query,
-   payloads?,
-   account?,
-additionalSigners?): Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-### Parameters
-#### query
-`T`
-#### payloads?
-`Payload`[]
-#### account?
-`AccountInstance`
-#### additionalSigners?
-`AccountInstance`[]
-### Returns
-`Promise`\<\[`UnsignedQueryBoundWitness`, `Payload`[], `Payload`[]\]\>
-### Inherited from
-```ts
-AbstractArchivist.bindQueryInternal
-```
-***
-### bindQueryResult()
-```ts
-protected bindQueryResult<T>(
-   query,
-   payloads,
-   additionalWitnesses?,
-errors?): Promise<ModuleQueryResult>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-### Parameters
-#### query
-`T`
-#### payloads
-`Payload`[]
-#### additionalWitnesses?
-`AccountInstance`[]
-#### errors?
-`ModuleError`[]
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractArchivist.bindQueryResult
-```
-***
-### generateConfigAndAddress()
-```ts
-protected generateConfigAndAddress(_maxDepth?): Promisable<Payload[]>;
-```
-### Parameters
-#### \_maxDepth?
-`number`
-### Returns
-`Promisable`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractArchivist.generateConfigAndAddress
-```
-***
-### generateDescribe()
-```ts
-protected generateDescribe(): Promise<ModuleDescriptionPayload>;
-```
-### Returns
-`Promise`\<`ModuleDescriptionPayload`\>
-### Inherited from
-```ts
-AbstractArchivist.generateDescribe
-```
-***
-### ~~getArchivist()~~
-```ts
-protected getArchivist(): Promise<
-  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
-| undefined>;
-```
-### Returns
-`Promise`\<
-  \| `ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>
-  \| `undefined`\>
-### Deprecated
-use archivistInstance() instead
-### Inherited from
-```ts
-AbstractArchivist.getArchivist
-```
-***
-### isAllowedArchivingQuery()
-```ts
-protected isAllowedArchivingQuery(schema): boolean;
-```
-### Parameters
-#### schema
-`Schema`
-### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractArchivist.isAllowedArchivingQuery
-```
-***
-### moduleAddressHandler()
-```ts
-protected moduleAddressHandler(): Promisable<(AddressPayload | AddressPreviousHashPayload)[]>;
-```
-### Returns
-`Promisable`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
-### Inherited from
-```ts
-AbstractArchivist.moduleAddressHandler
-```
-***
-### stopHandler()
-```ts
-protected stopHandler(): Promise<void>;
-```
-Override in subclasses to define stop behavior. Throw an error on failure.
-### Returns
-`Promise`\<`void`\>
-### Inherited from
-```ts
-AbstractArchivist.stopHandler
-```
-***
-### subscribeHandler()
-```ts
-protected subscribeHandler(): void;
-```
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractArchivist.subscribeHandler
-```
-***
-### validateConfig()
-```ts
-protected validateConfig(config?, parents?): boolean;
-```
-### Parameters
-#### config?
-`unknown`
-#### parents?
-`string`[]
-### Returns
-`boolean`
-### Inherited from
-```ts
-AbstractArchivist.validateConfig
-```
-***
-### addParent()
-```ts
-addParent(mod): void;
-```
-### Parameters
-#### mod
-`ModuleInstance`
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractArchivist.addParent
-```
-***
-### certifyParents()
-```ts
-certifyParents(): Promise<Payload[]>;
-```
-### Returns
-`Promise`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractArchivist.certifyParents
-```
-***
-### createHandler()
-```ts
-createHandler(): Promise<void>;
-```
-### Returns
-`Promise`\<`void`\>
-### Inherited from
-```ts
-AbstractArchivist.createHandler
-```
-***
-### manifest()
-```ts
-manifest(maxDepth?): Promise<ModuleManifestPayload>;
-```
-### Parameters
-#### maxDepth?
-`number`
-### Returns
-`Promise`\<`ModuleManifestPayload`\>
-### Inherited from
-```ts
-AbstractArchivist.manifest
-```
-***
-### manifestQuery()
-```ts
-manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;
-```
-### Parameters
-#### account
-`AccountInstance`
-#### maxDepth?
-`number`
-### Returns
-`Promise`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
-### Inherited from
-```ts
-AbstractArchivist.manifestQuery
-```
-***
-### moduleAddress()
-```ts
-moduleAddress(): Promise<(AddressPayload | AddressPreviousHashPayload)[]>;
-```
-### Returns
-`Promise`\<(`AddressPayload` \| `AddressPreviousHashPayload`)[]\>
-### Inherited from
-```ts
-AbstractArchivist.moduleAddress
-```
-***
-### parents()
-```ts
-parents(): Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>;
-```
-### Returns
-`Promisable`\<`NodeInstance`\<`NodeParams`\<`AnyConfigSchema`\<`NodeConfig`\>\>, `NodeModuleEventData`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.parents
-```
-***
-### privateChildren()
-```ts
-privateChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.privateChildren
-```
-***
-### publicChildren()
-```ts
-publicChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.publicChildren
-```
-***
-### removeParent()
-```ts
-removeParent(address): void;
-```
-### Parameters
-#### address
-`BrandedAddress`
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractArchivist.removeParent
-```
-***
-### resolve()
-### Call Signature
-```ts
-resolve(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-#### Returns
-`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-#### Inherited from
-```ts
-AbstractArchivist.resolve
-```
-### Call Signature
-```ts
-resolve<T>(all, options?): Promise<T[]>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### all
-`"*"`
-##### options?
-`ModuleFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T`[]\>
-#### Inherited from
-```ts
-AbstractArchivist.resolve
-```
-### Call Signature
-```ts
-resolve<T>(id, options?): Promise<T | undefined>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### id
-`ModuleIdentifier`
-##### options?
-`ModuleFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T` \| `undefined`\>
-#### Inherited from
-```ts
-AbstractArchivist.resolve
-```
-***
-### resolveIdentifier()
-```ts
-resolveIdentifier(id, options?): Promise<BrandedAddress | undefined>;
-```
-### Parameters
-#### id
-`ModuleIdentifier`
-#### options?
-`ObjectFilterOptions`\<`AnyObject`\>
-### Returns
-`Promise`\<`BrandedAddress` \| `undefined`\>
-### Inherited from
-```ts
-AbstractArchivist.resolveIdentifier
-```
-***
-### resolvePrivate()
-### Call Signature
-```ts
-resolvePrivate<T>(all, options?): Promise<T[]>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### all
-`"*"`
-##### options?
-`ModuleFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T`[]\>
-#### Inherited from
-```ts
-AbstractArchivist.resolvePrivate
-```
-### Call Signature
-```ts
-resolvePrivate<T>(id, options?): Promise<T | undefined>;
-```
-#### Type Parameters
-##### T
-`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
-#### Parameters
-##### id
-`ModuleIdentifier`
-##### options?
-`ModuleFilterOptions`\<`T`\>
-#### Returns
-`Promise`\<`T` \| `undefined`\>
-#### Inherited from
-```ts
-AbstractArchivist.resolvePrivate
-```
-***
-### siblings()
-```ts
-siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
-```
-### Returns
-`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.siblings
-```
-***
-### state()
-```ts
-state(): Promise<Payload[]>;
-```
-### Returns
-`Promise`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractArchivist.state
-```
-***
-### stateQuery()
-```ts
-stateQuery(account): Promise<ModuleQueryResult>;
-```
-### Parameters
-#### account
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\>
-### Inherited from
-```ts
-AbstractArchivist.stateQuery
-```
-***
-### subscribe()
-```ts
-subscribe(_queryAccount?): void;
-```
-### Parameters
-#### \_queryAccount?
-`AccountInstance`
-### Returns
-`void`
-### Inherited from
-```ts
-AbstractArchivist.subscribe
-```
-***
-### manifestHandler()
-```ts
-protected manifestHandler(maxDepth?, _ignoreAddresses?): Promise<ModuleManifestPayload>;
-```
-### Parameters
-#### maxDepth?
-`number`
-#### \_ignoreAddresses?
-`BrandedAddress`[]
-### Returns
-`Promise`\<`ModuleManifestPayload`\>
-### Inherited from
-```ts
-AbstractArchivist.manifestHandler
-```
-***
-### resolveArchivingArchivists()
-```ts
-protected resolveArchivingArchivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;
-```
-### Returns
-`Promise`\<`ArchivistInstance`\<`ArchivistParams`\<`AnyConfigSchema`\<`ArchivistConfig`\>\>, `ArchivistModuleEventData`, `Payload`\>[]\>
-### Inherited from
-```ts
-AbstractArchivist.resolveArchivingArchivists
-```
-***
-### sendQuery()
-```ts
-protected sendQuery<T, P, R>(
-   queryPayload,
-   payloads?,
-account?): Promise<R[]>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-#### P
-`P` *extends* `Payload` = `Payload`
-#### R
-`R` *extends* `Payload` = `Payload`
-### Parameters
-#### queryPayload
-`T`
-#### payloads?
-`P`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<`R`[]\>
-### Inherited from
-```ts
-AbstractArchivist.sendQuery
-```
-***
-### sendQueryRaw()
-```ts
-protected sendQueryRaw<T, P, R>(
-   queryPayload,
-   payloads?,
-account?): Promise<ModuleQueryResult<R>>;
-```
-### Type Parameters
-#### T
-`T` *extends* `Query`
-#### P
-`P` *extends* `Payload` = `Payload`
-#### R
-`R` *extends* `Payload` = `Payload`
-### Parameters
-#### queryPayload
-`T`
-#### payloads?
-`P`[]
-#### account?
-`AccountInstance`
-### Returns
-`Promise`\<`ModuleQueryResult`\<`R`\>\>
-### Inherited from
-```ts
-AbstractArchivist.sendQueryRaw
-```
-***
-### storeToArchivists()
-```ts
-protected storeToArchivists(payloads): Promise<Payload[]>;
-```
-### Parameters
-#### payloads
-`Payload`[]
-### Returns
-`Promise`\<`Payload`[]\>
-### Inherited from
-```ts
-AbstractArchivist.storeToArchivists
-```
-              ### interfaces
-                ### <a id="FirebaseArchivistParams"></a>FirebaseArchivistParams
-[**@xyo-network/archivist-firebase**](#../README)
-***
-## Extends
-- `ArchivistParams`\<`AnyConfigSchema`\<[`FirebaseArchivistConfig`](#../type-aliases/FirebaseArchivistConfig)\>\>
-## Properties
-### firebaseApp?
-```ts
-optional firebaseApp?: FirebaseApp;
-```
-***
-### keys?
-```ts
-optional keys?: ArchivistKeyParams<BrandedHash, Payload, BrandedHash>;
-```
-### Inherited from
-```ts
-ArchivistParams.keys
-```
-***
-### parents?
-```ts
-optional parents?: ArchivistParentInstances;
-```
-### Inherited from
-```ts
-ArchivistParams.parents
-```
-***
-### values?
-```ts
-optional values?: ArchivistValueParams<Payload, Payload>;
-```
-### Inherited from
-```ts
-ArchivistParams.values
-```
-***
-### account?
-```ts
-optional account?: AccountInstance | "random";
-```
-### Inherited from
-```ts
-ArchivistParams.account
-```
-***
-### addToResolvers?
-```ts
-optional addToResolvers?: boolean;
-```
-### Inherited from
-```ts
-ArchivistParams.addToResolvers
-```
-***
-### additionalSigners?
-```ts
-optional additionalSigners?: AccountInstance[];
-```
-### Inherited from
-```ts
-ArchivistParams.additionalSigners
-```
-***
-### allowNameResolution?
-```ts
-optional allowNameResolution?: boolean;
-```
-### Inherited from
-```ts
-ArchivistParams.allowNameResolution
-```
-***
-### config
-```ts
-config: Partial<TConfig>;
-```
-### Inherited from
-```ts
-ArchivistParams.config
-```
-***
-### ephemeralQueryAccountEnabled?
-```ts
-optional ephemeralQueryAccountEnabled?: boolean;
-```
-### Inherited from
-```ts
-ArchivistParams.ephemeralQueryAccountEnabled
-```
-***
-### moduleIdentifierTransformers?
-```ts
-optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
-```
-### Inherited from
-```ts
-ArchivistParams.moduleIdentifierTransformers
-```
-***
-### statusReporter?
-```ts
-optional statusReporter?: ModuleStatusReporter;
-```
-Optional reporter for broadcasting status changes.
-### Inherited from
-```ts
-ArchivistParams.statusReporter
-```
-              ### type-aliases
-                ### <a id="FirebaseArchivistConfig"></a>FirebaseArchivistConfig
-[**@xyo-network/archivist-firebase**](#../README)
-***
-```ts
-type FirebaseArchivistConfig = ArchivistConfig<{
-  collection?: string;
-  dbId?: string;
-  schema: FirebaseArchivistConfigSchema;
-}>;
-```
-                ### <a id="FirebaseArchivistConfigSchema"></a>FirebaseArchivistConfigSchema
-[**@xyo-network/archivist-firebase**](#../README)
-***
-```ts
-type FirebaseArchivistConfigSchema = typeof FirebaseArchivistConfigSchema;
-```
-                ### <a id="FirebaseArchivistSchema"></a>FirebaseArchivistSchema
-[**@xyo-network/archivist-firebase**](#../README)
-***
-```ts
-type FirebaseArchivistSchema = typeof FirebaseArchivistSchema;
-```
-              ### variables
-                ### <a id="FirebaseArchivistConfigSchema"></a>FirebaseArchivistConfigSchema
-[**@xyo-network/archivist-firebase**](#../README)
-***
-```ts
-const FirebaseArchivistConfigSchema: string & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
-                ### <a id="FirebaseArchivistSchema"></a>FirebaseArchivistSchema
-[**@xyo-network/archivist-firebase**](#../README)
-***
-```ts
-const FirebaseArchivistSchema: "network.xyo.archivist.firebase" & object;
-```
-## Type Declaration
-### \_\_schema
-```ts
-readonly __schema: true;
-```
 [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png