Class TemporalIndexingDivinerIndexCandidateToIndexDiviner<TParams>

Diviner which transforms index candidates to indexes using JSON Path to map source properties in the supplied payloads to destination fields in the resultant index

Type Parameters

TParams extends TemporalIndexingDivinerIndexCandidateToIndexDivinerParams = TemporalIndexingDivinerIndexCandidateToIndexDivinerParams

Hierarchy (View Summary)

AbstractDiviner<TParams>
- TemporalIndexingDivinerIndexCandidateToIndexDiviner

Index

Constructors

constructor

Methods

_checkDead _getRootFunction _noOverride addParent archivistInstance bindHashes bindHashesInternal bindQuery bindQueryInternal bindQueryResult busy certifyParents clearListeners divine divineHandler divineQuery emit emitSerial generateConfigAndAddress generateDescribe getArchivist isAllowedArchivingQuery isIndexablePayload isIndexableSchema listenerCount manifest manifestHandler manifestQuery moduleAddress moduleAddressHandler off offAny on onAny once parents previousHash privateChildren publicChildren query queryable queryHandler removeParent resolve resolveArchivingArchivists resolveIdentifier resolvePrivate sendQuery sendQueryRaw siblings start started startHandler state stateHandler stateQuery stop stopHandler storeToArchivists subscribe subscribeHandler validateConfig _getRootFunction _noOverride create determineAccount factory gc instanceCount instanceCounts startHistory stopHistory

Constructors

constructor

new TemporalIndexingDivinerIndexCandidateToIndexDiviner<
    TParams extends
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    consoleLogger?: LogLevel;
                    labels?: { [key: string]: undefined | string };
                    name?: string;
                    paging?: { [key: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: string;
                    schemaTransforms?: {
                        [key: string]: {
                            defaultValue?:
                                | null
                                | string
                                | number
                                | boolean
                                | {
                                    [key: string]: | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                }
                                | ((...) | (...) | (...) | (...) | (...) | (...) | (...))[];
                            destinationField: string;
                            sourcePathExpression: string;
                        }[];
                    };
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: { [key: string]: (Lowercase<(...)> | (...)[])[] };
                        disallowed?: { [key: string]: Lowercase<string>[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    timestamp?: boolean;
                },
            >;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
        } = BaseParamsFields & {
        account?: AccountInstance
        | "random";
        additionalSigners?: AccountInstance[];
        addToResolvers?: boolean;
        allowNameResolution?: boolean;
        config: DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: LogLevel;
                labels?: { [key: string]: undefined | string };
                name?: string;
                paging?: { [key: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: string;
                schemaTransforms?: {
                    [key: string]: {
                        defaultValue?:
                            | null
                            | string
                            | number
                            | boolean
                            | {
                                [key: string]: | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            }
                            | ((...) | (...) | (...) | (...) | (...) | (...) | (...))[];
                        destinationField: string;
                        sourcePathExpression: string;
                    }[];
                };
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [key: string]: (Lowercase<(...)> | (...)[])[] };
                    disallowed?: { [key: string]: Lowercase<string>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >;
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    },
>(
    privateConstructorKey: string,
    params: TParams,
    account: AccountInstance,
): TemporalIndexingDivinerIndexCandidateToIndexDiviner<TParams>
Type Parameters
- TParams extends BaseParamsFields & {
      account?: AccountInstance | "random";
      additionalSigners?: AccountInstance[];
      addToResolvers?: boolean;
      allowNameResolution?: boolean;
      config: DeepRestrictToStringKeys<
          {
              allowedQueries?: string[];
              archiving?: { archivists?: string[]; queries?: string[] };
              archivist?: string;
              consoleLogger?: LogLevel;
              labels?: { [key: string]: undefined | string };
              name?: string;
              paging?: { [key: string]: { size?: number } };
              retry?: { backoff?: number; interval?: number; retries?: number };
              schema: string;
              schemaTransforms?: {
                  [key: string]: {
                      defaultValue?:
                          | null
                          | string
                          | number
                          | boolean
                          | {
                              [key: string]: | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          }
                          | ((...) | (...) | (...) | (...) | (...) | (...) | (...))[];
                      destinationField: string;
                      sourcePathExpression: string;
                  }[];
              };
              security?: {
                  allowAnonymous?: boolean;
                  allowed?: { [key: string]: (Lowercase<(...)> | (...)[])[] };
                  disallowed?: { [key: string]: Lowercase<string>[] };
              };
              sign?: boolean;
              storeQueries?: boolean;
              timestamp?: boolean;
          },
      >;
      ephemeralQueryAccountEnabled?: boolean;
      moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
  } = BaseParamsFields & {
      account?: AccountInstance | "random";
      additionalSigners?: AccountInstance[];
      addToResolvers?: boolean;
      allowNameResolution?: boolean;
      config: DeepRestrictToStringKeys<
          {
              allowedQueries?: string[];
              archiving?: { archivists?: string[]; queries?: string[] };
              archivist?: string;
              consoleLogger?: LogLevel;
              labels?: { [key: string]: undefined | string };
              name?: string;
              paging?: { [key: string]: { size?: number } };
              retry?: { backoff?: number; interval?: number; retries?: number };
              schema: string;
              schemaTransforms?: {
                  [key: string]: {
                      defaultValue?:
                          | null
                          | string
                          | number
                          | boolean
                          | {
                              [key: string]: | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          }
                          | ((...) | (...) | (...) | (...) | (...) | (...) | (...))[];
                      destinationField: string;
                      sourcePathExpression: string;
                  }[];
              };
              security?: {
                  allowAnonymous?: boolean;
                  allowed?: { [key: string]: (Lowercase<(...)> | (...)[])[] };
                  disallowed?: { [key: string]: Lowercase<string>[] };
              };
              sign?: boolean;
              storeQueries?: boolean;
              timestamp?: boolean;
          },
      >;
      ephemeralQueryAccountEnabled?: boolean;
      moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
  }
Parameters
- privateConstructorKey: string
- params: TParams
- account: AccountInstance
Returns TemporalIndexingDivinerIndexCandidateToIndexDiviner<TParams>
Inherited from AbstractDiviner.constructor
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:184

Properties

`Protected`_account

_account: AccountInstance

`Protected`_cachedManifests

_cachedManifests: LRUCache<
    number,
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [x: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.module.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [x: Lowercase<string>]: null | string };
            };
        },
    >
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [x: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.node.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [x: Lowercase<string>]: null | string };
            };
        },
    >,
>

`Protected` `Optional`_lastError

_lastError?: ModuleDetailsError

`Protected`_started

_started: undefined | Promisable<boolean>

`Protected`_startPromise

_startPromise: undefined | Promisable<boolean>

`Static` `Readonly`allowRandomAccount

allowRandomAccount: boolean

`Static` `Readonly`configSchemas

configSchemas: string[] = ...

`Static` `Readonly`defaultConfigSchema

defaultConfigSchema: string = TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema

`Static`defaultLogger

defaultLogger: Logger

`Static`enableLazyLoad

enableLazyLoad: boolean

`Static` `Readonly`globalInstances

globalInstances: Record<string, WeakRef<Base<undefined | BaseParamsFields>>[]>

`Static` `Readonly`globalInstancesCountHistory

globalInstancesCountHistory: Record<string, number[]>

`Static`labels

labels: Labels = ...

`Protected` `Static`privateConstructorKey

privateConstructorKey: string

`Static`targetSchema

targetSchema: string

`Static` `Readonly`uniqueName

uniqueName: string

`Static` `Readonly`useNewResolver

useNewResolver: false

Accessors

account

get account(): AccountInstance
Returns AccountInstance
Inherited from AbstractDiviner.account
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:110

additionalSigners

get additionalSigners(): AccountInstance[]
Returns AccountInstance[]
Inherited from AbstractDiviner.additionalSigners
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:111

address

get address(): Lowercase<string>
Returns Lowercase<string>
Inherited from AbstractDiviner.address
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:112

allowAnonymous

get allowAnonymous(): boolean
Returns boolean
Inherited from AbstractDiviner.allowAnonymous
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:113

allowNameResolution

get allowNameResolution(): boolean
Returns boolean
Inherited from AbstractDiviner.allowNameResolution
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:114

archiving

get archiving(): undefined | { archivists?: string[]; queries?: string[] }
Returns undefined | { archivists?: string[]; queries?: string[] }
Inherited from AbstractDiviner.archiving
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:115

archivist

get archivist(): undefined | string
Returns undefined | string
Inherited from AbstractDiviner.archivist
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:116

config

get config(): TParams["config"]
Returns TParams["config"]
Inherited from AbstractDiviner.config
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:117

dead

get dead(): boolean
Returns boolean
Inherited from AbstractDiviner.dead
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:118

downResolver

get downResolver(): CompositeModuleResolver
Returns CompositeModuleResolver
Inherited from AbstractDiviner.downResolver
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:185

ephemeralQueryAccountEnabled

get ephemeralQueryAccountEnabled(): boolean
Returns boolean
Inherited from AbstractDiviner.ephemeralQueryAccountEnabled
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:119

id

get id(): string
Returns string
Inherited from AbstractDiviner.id
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:120

`Protected`indexableSchemas

get indexableSchemas(): string[]
List of indexable schemas for this diviner

Returns string[]
- Defined in packages/modules/packages/diviner/packages/indexing/packages/temporal/packages/memory/src/IndexCandidateToIndexDiviner/Diviner.ts:49

logger

get logger(): Logger
Returns Logger
Inherited from AbstractDiviner.logger
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:121

modName

get modName(): undefined | string
Returns undefined | string
Inherited from AbstractDiviner.modName
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:186

moduleIdentifierTransformers

get moduleIdentifierTransformers(): ModuleIdentifierTransformer[]
Returns ModuleIdentifierTransformer[]
Inherited from AbstractDiviner.moduleIdentifierTransformers
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:187

params

get params(): TParams
Returns TParams
Inherited from AbstractDiviner.params
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:28

`Protected`payloadTransformers

get payloadTransformers(): SchemaToPayloadTransformersDictionary
Dictionary of schemas to payload transformers for creating indexes from the payloads within a Bound Witness

Returns SchemaToPayloadTransformersDictionary
- Defined in packages/modules/packages/diviner/packages/indexing/packages/temporal/packages/memory/src/IndexCandidateToIndexDiviner/Diviner.ts:58

priority

get priority(): 2
Returns 2
Inherited from AbstractDiviner.priority
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:123

privateResolver

get privateResolver(): CompositeModuleResolver
Returns CompositeModuleResolver
Inherited from AbstractDiviner.privateResolver
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:188

queries

get queries(): string[]
Returns string[]
Inherited from AbstractDiviner.queries
- Defined in packages/modules/packages/diviner/packages/abstract/dist/neutral/index.d.ts:15

root

get root(): this
Returns this
Inherited from AbstractDiviner.root
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:189

`Protected`schemaTransforms

get schemaTransforms(): SchemaToJsonPathTransformExpressionsDictionary<
{ [schema: string]: unknown },
>
The dictionary of schemas to JSON Path transform expressions for creating indexes from the payloads within a Bound Witness

Returns SchemaToJsonPathTransformExpressionsDictionary<{ [schema: string]: unknown }>
- Defined in packages/modules/packages/diviner/packages/indexing/packages/temporal/packages/memory/src/IndexCandidateToIndexDiviner/Diviner.ts:67

status

get status(): ModuleStatus
Returns ModuleStatus
Inherited from AbstractDiviner.status
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:125
set status(value: ModuleStatus): void
Parameters
- value: ModuleStatus
Returns void
Inherited from AbstractDiviner.status
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:127

timestamp

get timestamp(): boolean
Returns boolean
Inherited from AbstractDiviner.timestamp
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:126

upResolver

get upResolver(): CompositeModuleResolver
Returns CompositeModuleResolver
Inherited from AbstractDiviner.upResolver
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:190

`Static`historyInterval

get historyInterval(): number
Returns number
Inherited from AbstractDiviner.historyInterval
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:20
set historyInterval(value: number): void
Parameters
- value: number
Returns void
Inherited from AbstractDiviner.historyInterval
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:21

`Static`historyTime

get historyTime(): number
Returns number
Inherited from AbstractDiviner.historyTime
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:22
set historyTime(value: number): void
Parameters
- value: number
Returns void
Inherited from AbstractDiviner.historyTime
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:23

`Static`maxGcFrequency

get maxGcFrequency(): number
Returns number
Inherited from AbstractDiviner.maxGcFrequency
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:24
set maxGcFrequency(value: number): void
Parameters
- value: number
Returns void
Inherited from AbstractDiviner.maxGcFrequency
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:25

`Static`maxHistoryDepth

get maxHistoryDepth(): number
Returns number
Inherited from AbstractDiviner.maxHistoryDepth
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:26

Methods

`Protected`_checkDead

_checkDead(): void
Returns void
Inherited from AbstractDiviner._checkDead
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:152

_getRootFunction

_getRootFunction(funcName: string): any
Parameters
- funcName: string
Returns any
Inherited from AbstractDiviner._getRootFunction
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:143

`Protected`_noOverride

_noOverride(functionName: string): void
Parameters
- functionName: string
Returns void
Inherited from AbstractDiviner._noOverride
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:153

addParent

addParent(mod: ModuleInstance): void
Parameters
- mod: ModuleInstance
Returns void
Inherited from AbstractDiviner.addParent
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:191

`Protected`archivistInstance

archivistInstance(): Promise<undefined | ArchivistInstance>
Returns Promise<undefined | ArchivistInstance>
Inherited from AbstractDiviner.archivistInstance
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:154
archivistInstance(required: true): Promise<ArchivistInstance>
Parameters
- required: true
Returns Promise<ArchivistInstance>
Inherited from AbstractDiviner.archivistInstance
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:155

`Protected`bindHashes

bindHashes(
    hashes: Lowercase<string>[],
    schema: string[],
    account?: AccountInstance,
): PromiseEx<unknown, AccountInstance>
Parameters
- hashes: Lowercase<string>[]
- schema: string[]
- Optionalaccount: AccountInstance
Returns PromiseEx<unknown, AccountInstance>
Inherited from AbstractDiviner.bindHashes
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:156

`Protected`bindHashesInternal

bindHashesInternal(
    hashes: Lowercase<string>[],
    schema: string[],
    account?: AccountInstance,
): Promise<BoundWitness>
Parameters
- hashes: Lowercase<string>[]
- schema: string[]
- Optionalaccount: AccountInstance
Returns Promise<BoundWitness>
Inherited from AbstractDiviner.bindHashesInternal
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:157

`Protected`bindQuery

bindQuery<
    T extends
        DeepRestrictToStringKeys<
            {
                address?: Lowercase<string>
                | Lowercase<string>[];
                budget?: number;
                maxFrequency?:
                    | "once"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "year";
                minBid?: number;
                schema: string;
            },
        >,
>(
    query: T,
    payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
    account?: AccountInstance,
    additionalSigners?: AccountInstance[],
): PromiseEx<
    [
        UnsignedQueryBoundWitness,
        DeepRestrictToStringKeys<{ schema: string }>[],
        DeepRestrictToStringKeys<{ schema: string }>[],
    ],
    AccountInstance,
>
Type Parameters
- T extends DeepRestrictToStringKeys<
      {
          address?: Lowercase<string>
          | Lowercase<string>[];
          budget?: number;
          maxFrequency?:
              | "once"
              | "second"
              | "minute"
              | "hour"
              | "day"
              | "week"
              | "month"
              | "year";
          minBid?: number;
          schema: string;
      },
  >
Parameters
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- Optionalaccount: AccountInstance
- OptionaladditionalSigners: AccountInstance[]
Returns PromiseEx<
    [
        UnsignedQueryBoundWitness,
        DeepRestrictToStringKeys<{ schema: string }>[],
        DeepRestrictToStringKeys<{ schema: string }>[],
    ],
    AccountInstance,
>
Inherited from AbstractDiviner.bindQuery
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:158

`Protected`bindQueryInternal

bindQueryInternal<
    T extends
        DeepRestrictToStringKeys<
            {
                address?: Lowercase<string>
                | Lowercase<string>[];
                budget?: number;
                maxFrequency?:
                    | "once"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "year";
                minBid?: number;
                schema: string;
            },
        >,
>(
    query: T,
    payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
    account?: AccountInstance,
    additionalSigners?: AccountInstance[],
): Promise<
    [
        UnsignedQueryBoundWitness,
        DeepRestrictToStringKeys<{ schema: string }>[],
        DeepRestrictToStringKeys<{ schema: string }>[],
    ],
>
Type Parameters
- T extends DeepRestrictToStringKeys<
      {
          address?: Lowercase<string>
          | Lowercase<string>[];
          budget?: number;
          maxFrequency?:
              | "once"
              | "second"
              | "minute"
              | "hour"
              | "day"
              | "week"
              | "month"
              | "year";
          minBid?: number;
          schema: string;
      },
  >
Parameters
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- Optionalaccount: AccountInstance
- OptionaladditionalSigners: AccountInstance[]
Returns Promise<
    [
        UnsignedQueryBoundWitness,
        DeepRestrictToStringKeys<{ schema: string }>[],
        DeepRestrictToStringKeys<{ schema: string }>[],
    ],
>
Inherited from AbstractDiviner.bindQueryInternal
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:159

`Protected`bindQueryResult

bindQueryResult<
    T extends
        DeepRestrictToStringKeys<
            {
                address?: Lowercase<string>
                | Lowercase<string>[];
                budget?: number;
                maxFrequency?:
                    | "once"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "year";
                minBid?: number;
                schema: string;
            },
        >,
>(
    query: T,
    payloads: DeepRestrictToStringKeys<{ schema: string }>[],
    additionalWitnesses?: AccountInstance[],
    errors?: DeepRestrictToStringKeys<
        {
            details?: | null
            | string
            | number
            | boolean
            | {
                [key: string]: | null
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[];
            }
            | (
                | null
                | string
                | number
                | boolean
                | {
                    [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                }
                | (
                    (string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null)[]
                )
            )[];
            message?: string;
            name?: string;
            query?: Lowercase<string>;
            schema: "network.xyo.error.module";
        },
    >[],
): Promise<ModuleQueryResult>
Type Parameters
- T extends DeepRestrictToStringKeys<
      {
          address?: Lowercase<string>
          | Lowercase<string>[];
          budget?: number;
          maxFrequency?:
              | "once"
              | "second"
              | "minute"
              | "hour"
              | "day"
              | "week"
              | "month"
              | "year";
          minBid?: number;
          schema: string;
      },
  >
Parameters
- query: T
- payloads: DeepRestrictToStringKeys<{ schema: string }>[]
- OptionaladditionalWitnesses: AccountInstance[]
- Optionalerrors: DeepRestrictToStringKeys<
      {
          details?: | null
          | string
          | number
          | boolean
          | {
              [key: string]: | null
              | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[];
          }
          | (
              | null
              | string
              | number
              | boolean
              | {
                  [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
              }
              | (
                  (string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null)[]
              )
          )[];
          message?: string;
          name?: string;
          query?: Lowercase<string>;
          schema: "network.xyo.error.module";
      },
  >[]
Returns Promise<ModuleQueryResult>
Inherited from AbstractDiviner.bindQueryResult
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:160

busy

busy<R>(closure: () => Promise<R>): Promise<R>
Type Parameters
- R
Parameters
- closure: () => Promise<R>
Returns Promise<R>
Inherited from AbstractDiviner.busy
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:144

certifyParents

certifyParents(): Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Returns Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Inherited from AbstractDiviner.certifyParents
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:192

clearListeners

clearListeners(
eventNames: string | number | symbol | (string | number | symbol)[],
): void
Parameters
- eventNames: string | number | symbol | (string | number | symbol)[]
Returns void
Inherited from AbstractDiviner.clearListeners
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:8

divine

divine(
    payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
    retryConfigIn?: RetryConfigWithComplete,
): Promise<
    DivinerDivineResult<DeepRestrictToStringKeys<{ schema: string }>>[],
>
Parameters
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- OptionalretryConfigIn: RetryConfigWithComplete
Returns Promise<DivinerDivineResult<DeepRestrictToStringKeys<{ schema: string }>>[]>
Inherited from AbstractDiviner.divine
- Defined in packages/modules/packages/diviner/packages/abstract/dist/neutral/index.d.ts:16

`Protected`divineHandler

divineHandler(
payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
): Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Parameters
- payloads: DeepRestrictToStringKeys<{ schema: string }>[] = []
Returns Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Overrides AbstractDiviner.divineHandler
- Defined in packages/modules/packages/diviner/packages/indexing/packages/temporal/packages/memory/src/IndexCandidateToIndexDiviner/Diviner.ts:71

divineQuery

divineQuery(
    payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
    account?: AccountInstance,
    _retry?: RetryConfig,
): Promise<ModuleQueryResult<DeepRestrictToStringKeys<{ schema: string }>>>
Parameters
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- Optionalaccount: AccountInstance
- Optional_retry: RetryConfig
Returns Promise<ModuleQueryResult<DeepRestrictToStringKeys<{ schema: string }>>>
Inherited from AbstractDiviner.divineQuery
- Defined in packages/modules/packages/diviner/packages/abstract/dist/neutral/index.d.ts:17

emit

emit<
    TEventName extends string
    | number
    | symbol = string | number | symbol,
    TEventArgs extends
        EventArgs = DivinerModuleEventData<
        DivinerInstance<TParams>,
        DeepRestrictToStringKeys<{ schema: string }>,
        DeepRestrictToStringKeys<{ schema: string }>,
    >[TEventName],
>(
    eventName: TEventName,
    eventArgs: TEventArgs,
): Promise<void>
Type Parameters
- TEventName extends string | number | symbol = string | number | symbol
- TEventArgs extends EventArgs = DivinerModuleEventData<
      DivinerInstance<TParams>,
      DeepRestrictToStringKeys<{ schema: string }>,
      DeepRestrictToStringKeys<{ schema: string }>,
  >[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Inherited from AbstractDiviner.emit
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:145

emitSerial

emitSerial<
    TEventName extends string
    | number
    | symbol = string | number | symbol,
    TEventArgs extends
        EventArgs = DivinerModuleEventData<
        DivinerInstance<TParams>,
        DeepRestrictToStringKeys<{ schema: string }>,
        DeepRestrictToStringKeys<{ schema: string }>,
    >[TEventName],
>(
    eventName: TEventName,
    eventArgs: TEventArgs,
): Promise<void>
Type Parameters
- TEventName extends string | number | symbol = string | number | symbol
- TEventArgs extends EventArgs = DivinerModuleEventData<
      DivinerInstance<TParams>,
      DeepRestrictToStringKeys<{ schema: string }>,
      DeepRestrictToStringKeys<{ schema: string }>,
  >[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Inherited from AbstractDiviner.emitSerial
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:10

`Protected`generateConfigAndAddress

generateConfigAndAddress(
_maxDepth?: number,
): Promisable<DeepRestrictToStringKeys<{ schema: string }>[]>
Parameters
- Optional_maxDepth: number
Returns Promisable<DeepRestrictToStringKeys<{ schema: string }>[]>
Inherited from AbstractDiviner.generateConfigAndAddress
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:161

`Protected`generateDescribe

generateDescribe(): Promise<
    DeepRestrictToStringKeys<
        {
            address: Lowercase<string>;
            children?: string[];
            name?: string;
            queries: string[];
            schema: "network.xyo.module.description";
        },
    >,
>
Returns Promise<
    DeepRestrictToStringKeys<
        {
            address: Lowercase<string>;
            children?: string[];
            name?: string;
            queries: string[];
            schema: "network.xyo.module.description";
        },
    >,
>
Inherited from AbstractDiviner.generateDescribe
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:162

`Protected`getArchivist

getArchivist(): Promise<undefined | ArchivistInstance>
Returns Promise<undefined | ArchivistInstance>
Inherited from AbstractDiviner.getArchivist
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:163

`Protected`isAllowedArchivingQuery

isAllowedArchivingQuery(schema: string): boolean
Parameters
- schema: string
Returns boolean
Inherited from AbstractDiviner.isAllowedArchivingQuery
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:164

`Protected`isIndexablePayload

isIndexablePayload(x: unknown): boolean
Identifies if a payload is one that is indexed by this diviner
Parameters
- x: unknown
  The candidate payload
Returns boolean
True if the payload is one indexed by this diviner, false otherwise
- Defined in packages/modules/packages/diviner/packages/indexing/packages/temporal/packages/memory/src/IndexCandidateToIndexDiviner/Diviner.ts:132

`Protected`isIndexableSchema

isIndexableSchema(schema?: null | string): boolean
Identifies if a schema is one that is indexed by this diviner
Parameters
- Optionalschema: null | string
  The candidate schema
Returns boolean
True if this schema is one indexed by this diviner, false otherwise
- Defined in packages/modules/packages/diviner/packages/indexing/packages/temporal/packages/memory/src/IndexCandidateToIndexDiviner/Diviner.ts:141

listenerCount

listenerCount(
eventNames: string | number | symbol | (string | number | symbol)[],
): number
Parameters
- eventNames: string | number | symbol | (string | number | symbol)[]
Returns number
Inherited from AbstractDiviner.listenerCount
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:11

manifest

manifest(
    maxDepth?: number,
): Promise<
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.module.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.node.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >,
>
Parameters
- OptionalmaxDepth: number
Returns Promise<
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.module.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.node.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >,
>
Inherited from AbstractDiviner.manifest
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:193

`Protected`manifestHandler

manifestHandler(
    maxDepth?: number,
    _ignoreAddresses?: Lowercase<string>[],
): Promise<
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.module.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.node.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >,
>
Parameters
- OptionalmaxDepth: number
- Optional_ignoreAddresses: Lowercase<string>[]
Returns Promise<
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.module.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.node.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >,
>
Inherited from AbstractDiviner.manifestHandler
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:214

manifestQuery

manifestQuery(
    account: AccountInstance,
    maxDepth?: number,
): Promise<
    ModuleQueryResult<
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.module.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.node.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >,
    >,
>
Parameters
- account: AccountInstance
- OptionalmaxDepth: number
Returns Promise<
    ModuleQueryResult<
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.module.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.node.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >,
    >,
>
Inherited from AbstractDiviner.manifestQuery
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:194

moduleAddress

moduleAddress(): Promise<
    (
        | DeepRestrictToStringKeys<
            {
                address: Lowercase<string>;
                previousHash?: string;
                schema: "network.xyo.address.hash.previous";
            },
        >
        | DeepRestrictToStringKeys<
            { address: Lowercase<string>; schema: "network.xyo.address" },
        >
    )[],
>
Returns Promise<
    (
        | DeepRestrictToStringKeys<
            {
                address: Lowercase<string>;
                previousHash?: string;
                schema: "network.xyo.address.hash.previous";
            },
        >
        | DeepRestrictToStringKeys<
            { address: Lowercase<string>; schema: "network.xyo.address" },
        >
    )[],
>
Inherited from AbstractDiviner.moduleAddress
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:195

`Protected`moduleAddressHandler

moduleAddressHandler(): Promisable<
    (
        | DeepRestrictToStringKeys<
            {
                address: Lowercase<string>;
                previousHash?: string;
                schema: "network.xyo.address.hash.previous";
            },
        >
        | DeepRestrictToStringKeys<
            { address: Lowercase<string>; schema: "network.xyo.address" },
        >
    )[],
>
Returns Promisable<
    (
        | DeepRestrictToStringKeys<
            {
                address: Lowercase<string>;
                previousHash?: string;
                schema: "network.xyo.address.hash.previous";
            },
        >
        | DeepRestrictToStringKeys<
            { address: Lowercase<string>; schema: "network.xyo.address" },
        >
    )[],
>
Inherited from AbstractDiviner.moduleAddressHandler
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:166

off

off<TEventName extends string | number | symbol>(
    eventNames: TEventName | TEventName[],
    listener: EventListener<
        DivinerModuleEventData<
            DivinerInstance<TParams>,
            DeepRestrictToStringKeys<{ schema: string }>,
            DeepRestrictToStringKeys<{ schema: string }>,
        >[TEventName],
    >,
): void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<
      DivinerModuleEventData<
          DivinerInstance<TParams>,
          DeepRestrictToStringKeys<{ schema: string }>,
          DeepRestrictToStringKeys<{ schema: string }>,
      >[TEventName],
  >
Returns void
Inherited from AbstractDiviner.off
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:12

offAny

offAny(listener: EventAnyListener): void
Parameters
- listener: EventAnyListener
Returns void
Inherited from AbstractDiviner.offAny
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:13

on

on<TEventName extends string | number | symbol>(
    eventNames: TEventName | TEventName[],
    listener: EventListener<
        DivinerModuleEventData<
            DivinerInstance<TParams>,
            DeepRestrictToStringKeys<{ schema: string }>,
            DeepRestrictToStringKeys<{ schema: string }>,
        >[TEventName],
    >,
): () => void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<
      DivinerModuleEventData<
          DivinerInstance<TParams>,
          DeepRestrictToStringKeys<{ schema: string }>,
          DeepRestrictToStringKeys<{ schema: string }>,
      >[TEventName],
  >
Returns () => void
Inherited from AbstractDiviner.on
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:14

onAny

onAny(listener: EventAnyListener): () => void
Parameters
- listener: EventAnyListener
Returns () => void
Inherited from AbstractDiviner.onAny
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:15

once

once<TEventName extends string | number | symbol>(
    eventName: TEventName,
    listener: EventListener<
        DivinerModuleEventData<
            DivinerInstance<TParams>,
            DeepRestrictToStringKeys<{ schema: string }>,
            DeepRestrictToStringKeys<{ schema: string }>,
        >[TEventName],
    >,
): () => void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- listener: EventListener<
      DivinerModuleEventData<
          DivinerInstance<TParams>,
          DeepRestrictToStringKeys<{ schema: string }>,
          DeepRestrictToStringKeys<{ schema: string }>,
      >[TEventName],
  >
Returns () => void
Inherited from AbstractDiviner.once
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:16

parents

parents(): Promisable<NodeInstance[]>
Returns Promisable<NodeInstance[]>
Inherited from AbstractDiviner.parents
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:196

previousHash

previousHash(): Promisable<undefined | string>
Returns Promisable<undefined | string>
Inherited from AbstractDiviner.previousHash
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:146

privateChildren

privateChildren(): Promisable<ModuleInstance[]>
Returns Promisable<ModuleInstance[]>
Inherited from AbstractDiviner.privateChildren
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:197

publicChildren

publicChildren(): Promisable<ModuleInstance[]>
Returns Promisable<ModuleInstance[]>
Inherited from AbstractDiviner.publicChildren
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:198

query

query<
    T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
    TConfig extends
        DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: LogLevel;
                labels?: { [key: string]: undefined | string };
                name?: string;
                paging?: { [key: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: "network.xyo.module.config";
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: {
                        [key: string]: (Lowercase<string> | Lowercase<string>[])[];
                    };
                    disallowed?: { [key: string]: Lowercase<string>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        > = DeepRestrictToStringKeys<
        {
            allowedQueries?: string[];
            archiving?: { archivists?: string[]; queries?: string[] };
            archivist?: string;
            consoleLogger?: LogLevel;
            labels?: { [key: string]: undefined | string };
            name?: string;
            paging?: { [key: string]: { size?: number } };
            retry?: { backoff?: number; interval?: number; retries?: number };
            schema: "network.xyo.module.config";
            security?: {
                allowAnonymous?: boolean;
                allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                disallowed?: { [key: string]: Lowercase<string>[] };
            };
            sign?: boolean;
            storeQueries?: boolean;
            timestamp?: boolean;
        },
    >,
>(
    query: T,
    payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
    queryConfig?: TConfig,
): Promise<ModuleQueryResult>
Type Parameters
- T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
- TConfig extends DeepRestrictToStringKeys<
      {
          allowedQueries?: string[];
          archiving?: { archivists?: string[]; queries?: string[] };
          archivist?: string;
          consoleLogger?: LogLevel;
          labels?: { [key: string]: undefined | string };
          name?: string;
          paging?: { [key: string]: { size?: number } };
          retry?: { backoff?: number; interval?: number; retries?: number };
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
              disallowed?: { [key: string]: Lowercase<string>[] };
          };
          sign?: boolean;
          storeQueries?: boolean;
          timestamp?: boolean;
      },
  > = DeepRestrictToStringKeys<
      {
          allowedQueries?: string[];
          archiving?: { archivists?: string[]; queries?: string[] };
          archivist?: string;
          consoleLogger?: LogLevel;
          labels?: { [key: string]: undefined | string };
          name?: string;
          paging?: { [key: string]: { size?: number } };
          retry?: { backoff?: number; interval?: number; retries?: number };
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
              disallowed?: { [key: string]: Lowercase<string>[] };
          };
          sign?: boolean;
          storeQueries?: boolean;
          timestamp?: boolean;
      },
  >
Parameters
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- OptionalqueryConfig: TConfig
Returns Promise<ModuleQueryResult>
Inherited from AbstractDiviner.query
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:147

queryable

queryable<
    T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
    TConfig extends
        DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: LogLevel;
                labels?: { [key: string]: undefined | string };
                name?: string;
                paging?: { [key: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: "network.xyo.module.config";
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: {
                        [key: string]: (Lowercase<string> | Lowercase<string>[])[];
                    };
                    disallowed?: { [key: string]: Lowercase<string>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        > = DeepRestrictToStringKeys<
        {
            allowedQueries?: string[];
            archiving?: { archivists?: string[]; queries?: string[] };
            archivist?: string;
            consoleLogger?: LogLevel;
            labels?: { [key: string]: undefined | string };
            name?: string;
            paging?: { [key: string]: { size?: number } };
            retry?: { backoff?: number; interval?: number; retries?: number };
            schema: "network.xyo.module.config";
            security?: {
                allowAnonymous?: boolean;
                allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                disallowed?: { [key: string]: Lowercase<string>[] };
            };
            sign?: boolean;
            storeQueries?: boolean;
            timestamp?: boolean;
        },
    >,
>(
    query: T,
    payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
    queryConfig?: TConfig,
): Promise<boolean>
Type Parameters
- T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
- TConfig extends DeepRestrictToStringKeys<
      {
          allowedQueries?: string[];
          archiving?: { archivists?: string[]; queries?: string[] };
          archivist?: string;
          consoleLogger?: LogLevel;
          labels?: { [key: string]: undefined | string };
          name?: string;
          paging?: { [key: string]: { size?: number } };
          retry?: { backoff?: number; interval?: number; retries?: number };
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
              disallowed?: { [key: string]: Lowercase<string>[] };
          };
          sign?: boolean;
          storeQueries?: boolean;
          timestamp?: boolean;
      },
  > = DeepRestrictToStringKeys<
      {
          allowedQueries?: string[];
          archiving?: { archivists?: string[]; queries?: string[] };
          archivist?: string;
          consoleLogger?: LogLevel;
          labels?: { [key: string]: undefined | string };
          name?: string;
          paging?: { [key: string]: { size?: number } };
          retry?: { backoff?: number; interval?: number; retries?: number };
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
              disallowed?: { [key: string]: Lowercase<string>[] };
          };
          sign?: boolean;
          storeQueries?: boolean;
          timestamp?: boolean;
      },
  >
Parameters
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- OptionalqueryConfig: TConfig
Returns Promise<boolean>
Inherited from AbstractDiviner.queryable
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:148

`Protected`queryHandler

queryHandler<
    T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
    TConfig extends
        DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: LogLevel;
                labels?: { [key: string]: undefined | string };
                name?: string;
                paging?: { [key: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: "network.xyo.module.config";
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: {
                        [key: string]: (Lowercase<string> | Lowercase<string>[])[];
                    };
                    disallowed?: { [key: string]: Lowercase<string>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        > = DeepRestrictToStringKeys<
        {
            allowedQueries?: string[];
            archiving?: { archivists?: string[]; queries?: string[] };
            archivist?: string;
            consoleLogger?: LogLevel;
            labels?: { [key: string]: undefined | string };
            name?: string;
            paging?: { [key: string]: { size?: number } };
            retry?: { backoff?: number; interval?: number; retries?: number };
            schema: "network.xyo.module.config";
            security?: {
                allowAnonymous?: boolean;
                allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                disallowed?: { [key: string]: Lowercase<string>[] };
            };
            sign?: boolean;
            storeQueries?: boolean;
            timestamp?: boolean;
        },
    >,
>(
    query: T,
    payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
    queryConfig?: TConfig,
): Promise<ModuleQueryHandlerResult>
Type Parameters
- T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
- TConfig extends DeepRestrictToStringKeys<
      {
          allowedQueries?: string[];
          archiving?: { archivists?: string[]; queries?: string[] };
          archivist?: string;
          consoleLogger?: LogLevel;
          labels?: { [key: string]: undefined | string };
          name?: string;
          paging?: { [key: string]: { size?: number } };
          retry?: { backoff?: number; interval?: number; retries?: number };
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
              disallowed?: { [key: string]: Lowercase<string>[] };
          };
          sign?: boolean;
          storeQueries?: boolean;
          timestamp?: boolean;
      },
  > = DeepRestrictToStringKeys<
      {
          allowedQueries?: string[];
          archiving?: { archivists?: string[]; queries?: string[] };
          archivist?: string;
          consoleLogger?: LogLevel;
          labels?: { [key: string]: undefined | string };
          name?: string;
          paging?: { [key: string]: { size?: number } };
          retry?: { backoff?: number; interval?: number; retries?: number };
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
              disallowed?: { [key: string]: Lowercase<string>[] };
          };
          sign?: boolean;
          storeQueries?: boolean;
          timestamp?: boolean;
      },
  >
Parameters
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- OptionalqueryConfig: TConfig
Returns Promise<ModuleQueryHandlerResult>
Inherited from AbstractDiviner.queryHandler
- Defined in packages/modules/packages/diviner/packages/abstract/dist/neutral/index.d.ts:18

removeParent

removeParent(address: Lowercase<string>): void
Parameters
- address: Lowercase<string>
Returns void
Inherited from AbstractDiviner.removeParent
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:199

resolve

resolve(): Promise<ModuleInstance[]>
Returns Promise<ModuleInstance[]>
Inherited from AbstractDiviner.resolve
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:200
resolve<T extends ModuleInstance = ModuleInstance>(
all: "*",
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- all: "*"
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Inherited from AbstractDiviner.resolve
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:201
resolve<T extends ModuleInstance = ModuleInstance>(
filter: ModuleFilter,
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- filter: ModuleFilter
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Inherited from AbstractDiviner.resolve
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:202
resolve<T extends ModuleInstance = ModuleInstance>(
id: string,
options?: ModuleFilterOptions<T>,
): Promise<undefined | T>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- id: string
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<undefined | T>
Inherited from AbstractDiviner.resolve
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:203
resolve<T extends ModuleInstance = ModuleInstance>(
filter?: ModuleFilter,
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- Optionalfilter: ModuleFilter
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Inherited from AbstractDiviner.resolve
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:204

`Protected`resolveArchivingArchivists

resolveArchivingArchivists(): Promise<ArchivistInstance[]>
Returns Promise<ArchivistInstance[]>
Inherited from AbstractDiviner.resolveArchivingArchivists
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:215

resolveIdentifier

resolveIdentifier(
id: string,
options?: ObjectFilterOptions,
): Promise<undefined | Lowercase<string>>
Parameters
- id: string
- Optionaloptions: ObjectFilterOptions
Returns Promise<undefined | Lowercase<string>>
Inherited from AbstractDiviner.resolveIdentifier
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:205

resolvePrivate

resolvePrivate<T extends ModuleInstance = ModuleInstance>(
all: "*",
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- all: "*"
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Inherited from AbstractDiviner.resolvePrivate
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:206
resolvePrivate<T extends ModuleInstance = ModuleInstance>(
id: string,
options?: ModuleFilterOptions<T>,
): Promise<undefined | T>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- id: string
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<undefined | T>
Inherited from AbstractDiviner.resolvePrivate
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:207

`Protected`sendQuery

sendQuery<
    T extends
        DeepRestrictToStringKeys<
            {
                address?: Lowercase<string>
                | Lowercase<string>[];
                budget?: number;
                maxFrequency?:
                    | "once"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "year";
                minBid?: number;
                schema: string;
            },
        >,
    P extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
    R extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
>(
    queryPayload: T,
    payloads?: P[],
    account?: AccountInstance,
): Promise<R[]>
Type Parameters
- T extends DeepRestrictToStringKeys<
      {
          address?: Lowercase<string>
          | Lowercase<string>[];
          budget?: number;
          maxFrequency?:
              | "once"
              | "second"
              | "minute"
              | "hour"
              | "day"
              | "week"
              | "month"
              | "year";
          minBid?: number;
          schema: string;
      },
  >
- P extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
- R extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
Parameters
- queryPayload: T
- Optionalpayloads: P[]
- Optionalaccount: AccountInstance
Returns Promise<R[]>
Inherited from AbstractDiviner.sendQuery
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:216

`Protected`sendQueryRaw

sendQueryRaw<
    T extends
        DeepRestrictToStringKeys<
            {
                address?: Lowercase<string>
                | Lowercase<string>[];
                budget?: number;
                maxFrequency?:
                    | "once"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "year";
                minBid?: number;
                schema: string;
            },
        >,
    P extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
    R extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
>(
    queryPayload: T,
    payloads?: P[],
    account?: AccountInstance,
): Promise<ModuleQueryResult<R>>
Type Parameters
- T extends DeepRestrictToStringKeys<
      {
          address?: Lowercase<string>
          | Lowercase<string>[];
          budget?: number;
          maxFrequency?:
              | "once"
              | "second"
              | "minute"
              | "hour"
              | "day"
              | "week"
              | "month"
              | "year";
          minBid?: number;
          schema: string;
      },
  >
- P extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
- R extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
Parameters
- queryPayload: T
- Optionalpayloads: P[]
- Optionalaccount: AccountInstance
Returns Promise<ModuleQueryResult<R>>
Inherited from AbstractDiviner.sendQueryRaw
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:217

siblings

siblings(): Promise<ModuleInstance[]>
Returns Promise<ModuleInstance[]>
Inherited from AbstractDiviner.siblings
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:208

start

start(_timeout?: number): Promisable<boolean>
Parameters
- Optional_timeout: number
Returns Promisable<boolean>
Inherited from AbstractDiviner.start
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:149

started

started(
notStartedAction?: "error" | "warn" | "log" | "throw" | "none",
tryStart?: boolean,
): Promise<boolean>
Parameters
- OptionalnotStartedAction: "error" | "warn" | "log" | "throw" | "none"
- OptionaltryStart: boolean
Returns Promise<boolean>
Inherited from AbstractDiviner.started
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:150

`Protected`startHandler

startHandler(): Promise<boolean>
Returns Promise<boolean>
Inherited from AbstractDiviner.startHandler
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:168

state

state(): Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Returns Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Inherited from AbstractDiviner.state
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:209

`Protected`stateHandler

stateHandler(): Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Returns Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Inherited from AbstractDiviner.stateHandler
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:169

stateQuery

stateQuery(account: AccountInstance): Promise<ModuleQueryResult>
Parameters
- account: AccountInstance
Returns Promise<ModuleQueryResult>
Inherited from AbstractDiviner.stateQuery
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:212

stop

stop(_timeout?: number): Promise<boolean>
Parameters
- Optional_timeout: number
Returns Promise<boolean>
Inherited from AbstractDiviner.stop
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:151

`Protected`stopHandler

stopHandler(_timeout?: number): Promisable<boolean>
Parameters
- Optional_timeout: number
Returns Promisable<boolean>
Inherited from AbstractDiviner.stopHandler
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:170

`Protected`storeToArchivists

storeToArchivists(
payloads: DeepRestrictToStringKeys<{ schema: string }>[],
): Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Parameters
- payloads: DeepRestrictToStringKeys<{ schema: string }>[]
Returns Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Inherited from AbstractDiviner.storeToArchivists
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:218

subscribe(_queryAccount?: AccountInstance): void
Parameters
- Optional_queryAccount: AccountInstance
Returns void
Inherited from AbstractDiviner.subscribe
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:213

`Protected`subscribeHandler

subscribeHandler(): void
Returns void
Inherited from AbstractDiviner.subscribeHandler
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:171

`Protected`validateConfig

validateConfig(config?: unknown, parents?: string[]): boolean
Parameters
- Optionalconfig: unknown
- Optionalparents: string[]
Returns boolean
Inherited from AbstractDiviner.validateConfig
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:172

`Static`_getRootFunction

_getRootFunction(funcName: string): any
Parameters
- funcName: string
Returns any
Inherited from AbstractDiviner._getRootFunction
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:130

`Static`_noOverride

_noOverride(functionName: string): void
Parameters
- functionName: string
Returns void
Inherited from AbstractDiviner._noOverride
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:131

`Static`create

create<TModule extends AttachableModuleInstance>(
    this: CreatableModule<TModule>,
    params: Omit<TModule["params"], "config"> & {
        config?: TModule["params"]["config"];
    },
): Promise<TModule>
Type Parameters
- TModule extends AttachableModuleInstance
Parameters
- this: CreatableModule<TModule>
- params: Omit<TModule["params"], "config"> & { config?: TModule["params"]["config"] }
Returns Promise<TModule>
Inherited from AbstractDiviner.create
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:132

`Static`determineAccount

determineAccount(
    params: {
        account?: AccountInstance | "random";
        accountPath?: string;
        wallet?: WalletInstance;
    },
): Promise<AccountInstance>
Parameters
- params: {
      account?: AccountInstance | "random";
      accountPath?: string;
      wallet?: WalletInstance;
  }
Returns Promise<AccountInstance>
Inherited from AbstractDiviner.determineAccount
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:135

`Static`factory

factory<TModule extends AttachableModuleInstance>(
    this: CreatableModule<TModule>,
    params: Omit<TModule["params"], "config"> & {
        config?: TModule["params"]["config"];
    },
): CreatableModuleFactory<TModule>
Type Parameters
- TModule extends AttachableModuleInstance
Parameters
- this: CreatableModule<TModule>
- params: Omit<TModule["params"], "config"> & { config?: TModule["params"]["config"] }
Returns CreatableModuleFactory<TModule>
Inherited from AbstractDiviner.factory
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:140

`Static`gc

gc(force?: boolean): void
Parameters
- Optionalforce: boolean
Returns void
Inherited from AbstractDiviner.gc
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:29
gc(className: string): void
Parameters
- className: string
Returns void
Inherited from AbstractDiviner.gc
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:30

`Static`instanceCount

instanceCount(className: string): number
Parameters
- className: string
Returns number
Inherited from AbstractDiviner.instanceCount
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:31

`Static`instanceCounts

instanceCounts(): Record<string, number>
Returns Record<string, number>
Inherited from AbstractDiviner.instanceCounts
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:32

`Static`startHistory

startHistory(): void
Returns void
Inherited from AbstractDiviner.startHistory
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:33

`Static`stopHistory

stopHistory(): void
Returns void
Inherited from AbstractDiviner.stopHistory
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:34

Class TemporalIndexingDivinerIndexCandidateToIndexDiviner<TParams>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TemporalIndexingDivinerIndexCandidateToIndexDiviner<TParams>

Properties

Protected_account

Protected_cachedManifests

Protected Optional_lastError

Protected_started

Protected_startPromise

eventData

Protected ReadonlymoduleConfigQueryValidator

Protected ReadonlysupportedQueryValidator

Static ReadonlyallowRandomAccount

Static ReadonlyconfigSchemas

Static ReadonlydefaultConfigSchema

StaticdefaultLogger

StaticenableLazyLoad

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

Staticlabels

Protected StaticprivateConstructorKey

StatictargetSchema

Static ReadonlyuniqueName

Static ReadonlyuseNewResolver

Accessors

account

Returns AccountInstance

additionalSigners

Returns AccountInstance[]

address

Returns Lowercase<string>

allowAnonymous

Returns boolean

allowNameResolution

Returns boolean

archiving

Returns undefined | { archivists?: string[]; queries?: string[] }

archivist

Returns undefined | string

config

Returns TParams["config"]

dead

Returns boolean

downResolver

Returns CompositeModuleResolver

ephemeralQueryAccountEnabled

Returns boolean

id

Returns string

ProtectedindexableSchemas

Returns string[]

logger

Returns Logger

modName

Returns undefined | string

moduleIdentifierTransformers

Returns ModuleIdentifierTransformer[]

params

Returns TParams

ProtectedpayloadTransformers

Returns SchemaToPayloadTransformersDictionary

priority

Returns 2

privateResolver

Returns CompositeModuleResolver

queries

Returns string[]

root

Returns this

ProtectedschemaTransforms

`Protected`_account

`Protected`_cachedManifests

`Protected` `Optional`_lastError

`Protected`_started

`Protected`_startPromise

`Protected` `Readonly`moduleConfigQueryValidator

`Protected` `Readonly`supportedQueryValidator

`Static` `Readonly`allowRandomAccount

`Static` `Readonly`configSchemas

`Static` `Readonly`defaultConfigSchema

`Static`defaultLogger

`Static`enableLazyLoad

`Static` `Readonly`globalInstances

`Static` `Readonly`globalInstancesCountHistory

`Static`labels

`Protected` `Static`privateConstructorKey

`Static`targetSchema

`Static` `Readonly`uniqueName

`Static` `Readonly`useNewResolver

`Protected`indexableSchemas

`Protected`payloadTransformers

`Protected`schemaTransforms

`Static`historyInterval

`Static`historyTime

`Static`maxGcFrequency

`Static`maxHistoryDepth

`Protected`_checkDead

`Protected`_noOverride

`Protected`archivistInstance

`Protected`bindHashes

`Protected`bindHashesInternal

`Protected`bindQuery

Returns PromiseEx<
[
UnsignedQueryBoundWitness,
DeepRestrictToStringKeys<{ schema: string }>[],
DeepRestrictToStringKeys<{ schema: string }>[],
],
AccountInstance,
>

`Protected`bindQueryInternal

Returns Promise<
[
UnsignedQueryBoundWitness,
DeepRestrictToStringKeys<{ schema: string }>[],
DeepRestrictToStringKeys<{ schema: string }>[],
],
>

`Protected`bindQueryResult

`Protected`divineHandler