Class JsonPathAggregateDiviner<TParams, TIn, TOut, TEventData>

Type Parameters

TParams extends JsonPathAggregateDivinerParams = JsonPathAggregateDivinerParams
TIn extends Payload = Payload
TOut extends Payload = Payload
TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut>

Hierarchy (View Summary)

AbstractDiviner<TParams, TIn, TOut, TEventData>
- JsonPathAggregateDiviner

Index

Constructors

Methods

_checkDead _getRootFunction _noOverride addParent archivistInstance bindHashes bindHashesInternal bindQuery bindQueryInternal bindQueryResult busy certifyParents clearListeners divine divineHandler divineQuery emit emitSerial generateConfigAndAddress generateDescribe getArchivist isAllowedArchivingQuery isTransformablePayload isTransformableSchema 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 JsonPathAggregateDiviner<
    TParams extends
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<JsonPathAggregateDivinerConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        } = BaseParamsFields & {
        account?: AccountInstance
        | "random";
        additionalSigners?: AccountInstance[];
        addToResolvers?: boolean;
        allowNameResolution?: boolean;
        config: AnyConfigSchema<JsonPathAggregateDivinerConfig>;
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
        privateChildren?: ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
            },
            ModuleEventData<object>,
        >[];
        publicChildren?: ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
            },
            ModuleEventData<object>,
        >[];
    },
    TIn extends Payload = Payload,
    TOut extends Payload = Payload,
    TEventData extends
        DivinerModuleEventData<
            DivinerInstance<TParams, TIn, TOut, DivinerModuleEventData>,
            TIn,
            TOut,
        > = DivinerModuleEventData<
        DivinerInstance<TParams, TIn, TOut, DivinerModuleEventData>,
        TIn,
        TOut,
    >,
>(
    privateConstructorKey: string,
    params: TParams,
    account: AccountInstance,
): JsonPathAggregateDiviner<TParams, TIn, TOut, TEventData>
Type Parameters
- TParams extends BaseParamsFields & {
      account?: AccountInstance | "random";
      additionalSigners?: AccountInstance[];
      addToResolvers?: boolean;
      allowNameResolution?: boolean;
      config: AnyConfigSchema<JsonPathAggregateDivinerConfig>;
      ephemeralQueryAccountEnabled?: boolean;
      moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
      privateChildren?: ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
              publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
          },
          ModuleEventData<object>,
      >[];
      publicChildren?: ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
              publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
          },
          ModuleEventData<object>,
      >[];
  } = BaseParamsFields & {
      account?: AccountInstance | "random";
      additionalSigners?: AccountInstance[];
      addToResolvers?: boolean;
      allowNameResolution?: boolean;
      config: AnyConfigSchema<JsonPathAggregateDivinerConfig>;
      ephemeralQueryAccountEnabled?: boolean;
      moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
      privateChildren?: ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
              publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
          },
          ModuleEventData<object>,
      >[];
      publicChildren?: ModuleInstance<
          BaseParamsFields & {
              account?: AccountInstance
              | "random";
              additionalSigners?: AccountInstance[];
              addToResolvers?: boolean;
              allowNameResolution?: boolean;
              config: AnyConfigSchema<ModuleConfig>;
              ephemeralQueryAccountEnabled?: boolean;
              moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
              privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
              publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
          },
          ModuleEventData<object>,
      >[];
  }
- TIn extends Payload = Payload
- TOut extends Payload = Payload
- TEventData extends DivinerModuleEventData<
      DivinerInstance<TParams, TIn, TOut, DivinerModuleEventData>,
      TIn,
      TOut,
  > = DivinerModuleEventData<
      DivinerInstance<TParams, TIn, TOut, DivinerModuleEventData>,
      TIn,
      TOut,
  >
Parameters
- privateConstructorKey: string
- params: TParams
- account: AccountInstance
Returns JsonPathAggregateDiviner<TParams, TIn, TOut, TEventData>
Inherited from AbstractDiviner.constructor
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:18

Properties

`Protected`_account

_account: AccountInstance

`Protected`_cachedManifests

_cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>

`Protected`_globalReentrancyMutex

_globalReentrancyMutex: undefined | Mutex

`Protected` `Optional`_lastError

_lastError?: ModuleDetailsError

`Protected`_started

_started: undefined | Promisable<boolean>

`Protected`_startPromise

_startPromise: undefined | Promisable<boolean>

`Protected`_transforms

_transforms: undefined | PayloadTransformer[]

eventData

eventData: TEventData

`Protected` `Readonly`moduleConfigQueryValidator

moduleConfigQueryValidator: Queryable

`Protected` `Readonly`supportedQueryValidator

supportedQueryValidator: Queryable

`Static` `Readonly`allowRandomAccount

allowRandomAccount: boolean

`Static` `Readonly`configSchemas

configSchemas: string[] = ...

`Static` `Readonly`defaultConfigSchema

defaultConfigSchema: string = JsonPathAggregateDivinerConfigSchema

`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` `Readonly`labels

labels: Labels

`Protected` `Static`privateConstructorKey

privateConstructorKey: string

`Static` `Readonly`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/types/AbstractModule.d.ts:37

additionalSigners

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

address

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

allowAnonymous

get allowAnonymous(): boolean
Returns boolean
Inherited from AbstractDiviner.allowAnonymous
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:40

allowNameResolution

get allowNameResolution(): boolean
Returns boolean
Inherited from AbstractDiviner.allowNameResolution
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:41

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/types/AbstractModule.d.ts:42

archivist

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

config

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

dead

get dead(): boolean
Returns boolean
Inherited from AbstractDiviner.dead
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:45

`Protected`destinationSchema

get destinationSchema(): string
The schema to use for the destination payloads

Returns string
- Defined in packages/modules/packages/diviner/packages/jsonpath/packages/aggregate/packages/memory/src/Diviner.ts:42

downResolver

get downResolver(): CompositeModuleResolver<CompositeModuleResolverParams>
Returns CompositeModuleResolver<CompositeModuleResolverParams>
Inherited from AbstractDiviner.downResolver
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:19

ephemeralQueryAccountEnabled

get ephemeralQueryAccountEnabled(): boolean
Returns boolean
Inherited from AbstractDiviner.ephemeralQueryAccountEnabled
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:46

globalReentrancyMutex

get globalReentrancyMutex(): undefined | Mutex
Returns undefined | Mutex
Inherited from AbstractDiviner.globalReentrancyMutex
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:47

id

get id(): string
The name (if specified) or address of the module

Returns string
Inherited from AbstractDiviner.id
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:48

logger

get logger(): Logger
Returns Logger
Inherited from AbstractDiviner.logger
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:49

modName

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

moduleIdentifierTransformers

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

params

get params(): TParams
Returns TParams
Inherited from AbstractDiviner.params
- Defined in node_modules/.store/@xylabs-object-npm-4.7.15-999645f30f/package/dist/types/Base.d.ts:28

`Protected`payloadTransformers

get payloadTransformers(): SchemaToPayloadTransformersDictionary
Dictionary of schemas to payload transformers

Returns SchemaToPayloadTransformersDictionary
- Defined in packages/modules/packages/diviner/packages/jsonpath/packages/aggregate/packages/memory/src/Diviner.ts:49

priority

get priority(): 2
Returns 2
Inherited from AbstractDiviner.priority
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:51

privateResolver

get privateResolver(): CompositeModuleResolver<CompositeModuleResolverParams>
Returns CompositeModuleResolver<CompositeModuleResolverParams>
Inherited from AbstractDiviner.privateResolver
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:22

queries

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

reentrancy

get reentrancy(): undefined | { action: "skip" | "wait"; scope: "global" }
Returns undefined | { action: "skip" | "wait"; scope: "global" }
Inherited from AbstractDiviner.reentrancy
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:53

root

get root(): this
Returns this
Inherited from AbstractDiviner.root
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:23

`Protected`schemaTransforms

get schemaTransforms(): SchemaToJsonPathTransformExpressionsDictionary
The dictionary of schemas to JSON Path transform expressions

Returns SchemaToJsonPathTransformExpressionsDictionary
- Defined in packages/modules/packages/diviner/packages/jsonpath/packages/aggregate/packages/memory/src/Diviner.ts:57

status

get status(): ModuleStatus
Returns ModuleStatus
Inherited from AbstractDiviner.status
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:57
set status(value: ModuleStatus): void
Parameters
- value: ModuleStatus
Returns void
Inherited from AbstractDiviner.status
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:59

timestamp

get timestamp(): boolean
Returns boolean
Inherited from AbstractDiviner.timestamp
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:58

`Protected`transformableSchemas

get transformableSchemas(): string[]
List of transformable schemas for this diviner

Returns string[]
- Defined in packages/modules/packages/diviner/packages/jsonpath/packages/aggregate/packages/memory/src/Diviner.ts:64

upResolver

get upResolver(): CompositeModuleResolver<CompositeModuleResolverParams>
Returns CompositeModuleResolver<CompositeModuleResolverParams>
Inherited from AbstractDiviner.upResolver
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:24

`Static`historyInterval

get historyInterval(): number
Returns number
Inherited from AbstractDiviner.historyInterval
- Defined in node_modules/.store/@xylabs-object-npm-4.7.15-999645f30f/package/dist/types/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.7.15-999645f30f/package/dist/types/Base.d.ts:21

`Static`historyTime

get historyTime(): number
Returns number
Inherited from AbstractDiviner.historyTime
- Defined in node_modules/.store/@xylabs-object-npm-4.7.15-999645f30f/package/dist/types/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.7.15-999645f30f/package/dist/types/Base.d.ts:23

`Static`maxGcFrequency

get maxGcFrequency(): number
Returns number
Inherited from AbstractDiviner.maxGcFrequency
- Defined in node_modules/.store/@xylabs-object-npm-4.7.15-999645f30f/package/dist/types/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.7.15-999645f30f/package/dist/types/Base.d.ts:25

`Static`maxHistoryDepth

get maxHistoryDepth(): number
Returns number
Inherited from AbstractDiviner.maxHistoryDepth
- Defined in node_modules/.store/@xylabs-object-npm-4.7.15-999645f30f/package/dist/types/Base.d.ts:26

Methods

`Protected`_checkDead

_checkDead(): void
Returns void
Inherited from AbstractDiviner._checkDead
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:84

_getRootFunction

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

`Protected`_noOverride

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

addParent

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

`Protected`archivistInstance

archivistInstance(): Promise<
    | undefined
    | ArchivistInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ArchivistConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        } & ArchivistParamFields & object,
        ArchivistModuleEventData,
        Payload,
    >,
>
Returns Promise<
    | undefined
    | ArchivistInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ArchivistConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        } & ArchivistParamFields & object,
        ArchivistModuleEventData,
        Payload,
    >,
>
Inherited from AbstractDiviner.archivistInstance
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:86
archivistInstance(
    required: true,
): Promise<
    ArchivistInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ArchivistConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        } & ArchivistParamFields & object,
        ArchivistModuleEventData,
        Payload,
    >,
>
Parameters
- required: true
Returns Promise<
    ArchivistInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ArchivistConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        } & ArchivistParamFields & object,
        ArchivistModuleEventData,
        Payload,
    >,
>
Inherited from AbstractDiviner.archivistInstance
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:87

`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/types/AbstractModule.d.ts:88

`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/types/AbstractModule.d.ts:89

`Protected`bindQuery

bindQuery<T extends Query>(
    query: T,
    payloads?: Payload[],
    account?: AccountInstance,
    additionalSigners?: AccountInstance[],
): PromiseEx<
    [UnsignedQueryBoundWitness, Payload[], Payload[]],
    AccountInstance,
>
Type Parameters
- T extends Query
Parameters
- query: T
- Optionalpayloads: Payload[]
- Optionalaccount: AccountInstance
- OptionaladditionalSigners: AccountInstance[]
Returns PromiseEx<[UnsignedQueryBoundWitness, Payload[], Payload[]], AccountInstance>
Inherited from AbstractDiviner.bindQuery
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:90

`Protected`bindQueryInternal

bindQueryInternal<T extends Query>(
    query: T,
    payloads?: Payload[],
    account?: AccountInstance,
    additionalSigners?: AccountInstance[],
): Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>
Type Parameters
- T extends Query
Parameters
- query: T
- Optionalpayloads: Payload[]
- Optionalaccount: AccountInstance
- OptionaladditionalSigners: AccountInstance[]
Returns Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>
Inherited from AbstractDiviner.bindQueryInternal
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:91

`Protected`bindQueryResult

bindQueryResult<T extends Query>(
    query: T,
    payloads: Payload[],
    additionalWitnesses?: AccountInstance[],
    errors?: ModuleError[],
): Promise<ModuleQueryResult>
Type Parameters
- T extends Query
Parameters
- query: T
- payloads: Payload[]
- OptionaladditionalWitnesses: AccountInstance[]
- Optionalerrors: ModuleError[]
Returns Promise<ModuleQueryResult>
Inherited from AbstractDiviner.bindQueryResult
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:92

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/types/AbstractModule.d.ts:76

certifyParents

certifyParents(): Promise<Payload[]>
Returns Promise<Payload[]>
Inherited from AbstractDiviner.certifyParents
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:26

clearListeners

clearListeners(eventNames: keyof TEventData | (keyof TEventData)[]): void
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns void
Inherited from AbstractDiviner.clearListeners
- Defined in packages/modules/packages/module/packages/emitter/dist/types/BaseEmitter.d.ts:8

divine

divine(
payloads?: TIn[],
retryConfigIn?: RetryConfigWithComplete<unknown>,
): Promise<DeepOmitStartsWith<TOut, "__">[]>
Function
divine The main entry point for a diviner. Do not override this function. Implement/override divineHandler for custom functionality
Parameters
- Optionalpayloads: TIn[]
- OptionalretryConfigIn: RetryConfigWithComplete<unknown>
Returns Promise<DeepOmitStartsWith<TOut, "__">[]>
Inherited from AbstractDiviner.divine
- Defined in packages/modules/packages/diviner/packages/abstract/dist/types/AbstractDiviner.d.ts:16

`Protected`divineHandler

divineHandler(payloads?: TIn[]): Promise<TOut[]>
Function
divineHandler Implement or override to add custom functionality to a diviner
Parameters
- Optionalpayloads: TIn[]
Returns Promise<TOut[]>
Overrides AbstractDiviner.divineHandler
- Defined in packages/modules/packages/diviner/packages/jsonpath/packages/aggregate/packages/memory/src/Diviner.ts:69

divineQuery

divineQuery(
    payloads?: TIn[],
    account?: AccountInstance,
    _retry?: RetryConfig,
): Promise<ModuleQueryResult<TOut>>
Parameters
- Optionalpayloads: TIn[]
- Optionalaccount: AccountInstance
- Optional_retry: RetryConfig
Returns Promise<ModuleQueryResult<TOut>>
Inherited from AbstractDiviner.divineQuery
- Defined in packages/modules/packages/diviner/packages/abstract/dist/types/AbstractDiviner.d.ts:17

emit

emit<
    TEventName extends string
    | number
    | symbol = keyof TEventData,
    TEventArgs extends EventArgs = TEventData[TEventName],
>(
    eventName: TEventName,
    eventArgs: TEventArgs,
): Promise<void>
Type Parameters
- TEventName extends string | number | symbol = keyof TEventData
- TEventArgs extends EventArgs = TEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Inherited from AbstractDiviner.emit
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:77

emitSerial

emitSerial<
    TEventName extends string
    | number
    | symbol = keyof TEventData,
    TEventArgs extends EventArgs = TEventData[TEventName],
>(
    eventName: TEventName,
    eventArgs: TEventArgs,
): Promise<void>
Type Parameters
- TEventName extends string | number | symbol = keyof TEventData
- TEventArgs extends EventArgs = TEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Inherited from AbstractDiviner.emitSerial
- Defined in packages/modules/packages/module/packages/emitter/dist/types/BaseEmitter.d.ts:10

`Protected`generateConfigAndAddress

generateConfigAndAddress(_maxDepth?: number): Promisable<Payload[]>
Parameters
- Optional_maxDepth: number
Returns Promisable<Payload[]>
Inherited from AbstractDiviner.generateConfigAndAddress
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:93

`Protected`generateDescribe

generateDescribe(): Promise<ModuleDescriptionPayload>
Returns Promise<ModuleDescriptionPayload>
Inherited from AbstractDiviner.generateDescribe
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:94

`Protected`getArchivist

getArchivist(): Promise<
    | undefined
    | ArchivistInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ArchivistConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        } & ArchivistParamFields & object,
        ArchivistModuleEventData,
        Payload,
    >,
>
Returns Promise<
    | undefined
    | ArchivistInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ArchivistConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        } & ArchivistParamFields & object,
        ArchivistModuleEventData,
        Payload,
    >,
>
Deprecated
use archivistInstance() instead
Inherited from AbstractDiviner.getArchivist
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:96

`Protected`isAllowedArchivingQuery

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

`Protected`isTransformablePayload

isTransformablePayload(x: Payload): boolean
Identifies if a payload is one that is transformed by this diviner
Parameters
- x: Payload
  The candidate payload
Returns boolean
True if the payload is one transformed by this diviner, false otherwise
- Defined in packages/modules/packages/diviner/packages/jsonpath/packages/aggregate/packages/memory/src/Diviner.ts:91

`Protected`isTransformableSchema

isTransformableSchema(schema?: null | string): boolean
Identifies if a schema is one that is transformed by this diviner
Parameters
- Optionalschema: null | string
  The candidate schema
Returns boolean
True if this schema is one transformed by this diviner, false otherwise
- Defined in packages/modules/packages/diviner/packages/jsonpath/packages/aggregate/packages/memory/src/Diviner.ts:100

listenerCount

listenerCount(eventNames: keyof TEventData | (keyof TEventData)[]): number
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns number
Inherited from AbstractDiviner.listenerCount
- Defined in packages/modules/packages/module/packages/emitter/dist/types/BaseEmitter.d.ts:11

manifest

manifest(maxDepth?: number): Promise<ModuleManifestPayload>
Parameters
- OptionalmaxDepth: number
Returns Promise<ModuleManifestPayload>
Inherited from AbstractDiviner.manifest
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:27

`Protected`manifestHandler

manifestHandler(
maxDepth?: number,
_ignoreAddresses?: Lowercase<string>[],
): Promise<ModuleManifestPayload>
Parameters
- OptionalmaxDepth: number
- Optional_ignoreAddresses: Lowercase<string>[]
Returns Promise<ModuleManifestPayload>
Inherited from AbstractDiviner.manifestHandler
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:44

manifestQuery

manifestQuery(
account: AccountInstance,
maxDepth?: number,
): Promise<ModuleQueryResult<ModuleManifestPayload>>
Parameters
- account: AccountInstance
- OptionalmaxDepth: number
Returns Promise<ModuleQueryResult<ModuleManifestPayload>>
Inherited from AbstractDiviner.manifestQuery
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:28

moduleAddress

moduleAddress(): Promise<(AddressPayload | AddressPreviousHashPayload)[]>
Returns Promise<(AddressPayload | AddressPreviousHashPayload)[]>
Inherited from AbstractDiviner.moduleAddress
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:29

`Protected`moduleAddressHandler

moduleAddressHandler(): Promisable<
(AddressPayload | AddressPreviousHashPayload)[],
>
Returns Promisable<(AddressPayload | AddressPreviousHashPayload)[]>
Inherited from AbstractDiviner.moduleAddressHandler
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:99

off

off<TEventName extends string | number | symbol>(
eventNames: TEventName | TEventName[],
listener: EventListener<TEventData[TEventName]>,
): void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns void
Inherited from AbstractDiviner.off
- Defined in packages/modules/packages/module/packages/emitter/dist/types/BaseEmitter.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/types/BaseEmitter.d.ts:13

on

on<TEventName extends string | number | symbol>(
eventNames: TEventName | TEventName[],
listener: EventListener<TEventData[TEventName]>,
): () => void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns () => void
Inherited from AbstractDiviner.on
- Defined in packages/modules/packages/module/packages/emitter/dist/types/BaseEmitter.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/types/BaseEmitter.d.ts:15

once

once<TEventName extends string | number | symbol>(
eventName: TEventName,
listener: EventListener<TEventData[TEventName]>,
): () => void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- listener: EventListener<TEventData[TEventName]>
Returns () => void
Inherited from AbstractDiviner.once
- Defined in packages/modules/packages/module/packages/emitter/dist/types/BaseEmitter.d.ts:16

parents

parents(): Promisable<
    NodeInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<NodeConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        },
        NodeModuleEventData,
    >[],
>
Returns Promisable<
    NodeInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<NodeConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        },
        NodeModuleEventData,
    >[],
>
Inherited from AbstractDiviner.parents
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:30

previousHash

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

privateChildren

privateChildren(): Promisable<
    ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
        },
        ModuleEventData<object>,
    >[],
>
Returns Promisable<
    ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
        },
        ModuleEventData<object>,
    >[],
>
Inherited from AbstractDiviner.privateChildren
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:31

publicChildren

publicChildren(): Promisable<
    ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
        },
        ModuleEventData<object>,
    >[],
>
Returns Promisable<
    ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
        },
        ModuleEventData<object>,
    >[],
>
Inherited from AbstractDiviner.publicChildren
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:32

query

query<
    T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
    TConfig extends ModuleConfig = ModuleConfig,
>(
    query: T,
    payloads?: Payload[],
    queryConfig?: TConfig,
): Promise<ModuleQueryResult>
Type Parameters
- T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
- TConfig extends ModuleConfig = ModuleConfig
Parameters
- query: T
- Optionalpayloads: Payload[]
- OptionalqueryConfig: TConfig
Returns Promise<ModuleQueryResult>
Inherited from AbstractDiviner.query
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:79

queryable

queryable<
    T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
    TConfig extends ModuleConfig = ModuleConfig,
>(
    query: T,
    payloads?: Payload[],
    queryConfig?: TConfig,
): Promise<boolean>
Type Parameters
- T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
- TConfig extends ModuleConfig = ModuleConfig
Parameters
- query: T
- Optionalpayloads: Payload[]
- OptionalqueryConfig: TConfig
Returns Promise<boolean>
Inherited from AbstractDiviner.queryable
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:80

`Protected`queryHandler

queryHandler<
    T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
    TConfig extends ModuleConfig = ModuleConfig,
>(
    query: T,
    payloads?: Payload[],
    queryConfig?: TConfig,
): Promise<ModuleQueryHandlerResult>
Function
queryHandler Calls divine for a divine query. Override to support additional queries.
Type Parameters
- T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
- TConfig extends ModuleConfig = ModuleConfig
Parameters
- query: T
- Optionalpayloads: Payload[]
- OptionalqueryConfig: TConfig
Returns Promise<ModuleQueryHandlerResult>
Inherited from AbstractDiviner.queryHandler
- Defined in packages/modules/packages/diviner/packages/abstract/dist/types/AbstractDiviner.d.ts:19

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/types/AbstractModuleInstance.d.ts:33

resolve

resolve(): Promise<
    ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
        },
        ModuleEventData<object>,
    >[],
>
Returns Promise<
    ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
        },
        ModuleEventData<object>,
    >[],
>
Deprecated
do not pass undefined. If trying to get all, pass '*'
Inherited from AbstractDiviner.resolve
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:34
resolve<
    T extends
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
                publicChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
            },
            ModuleEventData<object>,
        > = ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: (
                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
            )[];
            publicChildren?: (
                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
            )[];
        },
        ModuleEventData<object>,
    >,
>(
    all: "*",
    options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance<
      BaseParamsFields & {
          account?: AccountInstance
          | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<ModuleConfig>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
          publicChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
      },
      ModuleEventData<object>,
  > = ModuleInstance<
      BaseParamsFields & {
          account?: AccountInstance
          | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<ModuleConfig>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
          publicChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
      },
      ModuleEventData<object>,
  >
Parameters
- all: "*"
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Inherited from AbstractDiviner.resolve
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:35
resolve<
    T extends
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
                publicChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
            },
            ModuleEventData<object>,
        > = ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: (
                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
            )[];
            publicChildren?: (
                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
            )[];
        },
        ModuleEventData<object>,
    >,
>(
    id: string,
    options?: ModuleFilterOptions<T>,
): Promise<undefined | T>
Type Parameters
- T extends ModuleInstance<
      BaseParamsFields & {
          account?: AccountInstance
          | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<ModuleConfig>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
          publicChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
      },
      ModuleEventData<object>,
  > = ModuleInstance<
      BaseParamsFields & {
          account?: AccountInstance
          | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<ModuleConfig>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
          publicChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
      },
      ModuleEventData<object>,
  >
Parameters
- id: string
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<undefined | T>
Inherited from AbstractDiviner.resolve
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:36

`Protected`resolveArchivingArchivists

resolveArchivingArchivists(): Promise<
    ArchivistInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ArchivistConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        } & ArchivistParamFields & object,
        ArchivistModuleEventData,
        Payload,
    >[],
>
Returns Promise<
    ArchivistInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ArchivistConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        } & ArchivistParamFields & object,
        ArchivistModuleEventData,
        Payload,
    >[],
>
Inherited from AbstractDiviner.resolveArchivingArchivists
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:45

resolveIdentifier

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

resolvePrivate

resolvePrivate<
    T extends
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
                publicChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
            },
            ModuleEventData<object>,
        > = ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: (
                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
            )[];
            publicChildren?: (
                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
            )[];
        },
        ModuleEventData<object>,
    >,
>(
    all: "*",
    options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance<
      BaseParamsFields & {
          account?: AccountInstance
          | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<ModuleConfig>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
          publicChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
      },
      ModuleEventData<object>,
  > = ModuleInstance<
      BaseParamsFields & {
          account?: AccountInstance
          | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<ModuleConfig>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
          publicChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
      },
      ModuleEventData<object>,
  >
Parameters
- all: "*"
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Inherited from AbstractDiviner.resolvePrivate
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:38
resolvePrivate<
    T extends
        ModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
                publicChildren?: (
                    ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
                )[];
            },
            ModuleEventData<object>,
        > = ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: (
                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
            )[];
            publicChildren?: (
                ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
            )[];
        },
        ModuleEventData<object>,
    >,
>(
    id: string,
    options?: ModuleFilterOptions<T>,
): Promise<undefined | T>
Type Parameters
- T extends ModuleInstance<
      BaseParamsFields & {
          account?: AccountInstance
          | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<ModuleConfig>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
          publicChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
      },
      ModuleEventData<object>,
  > = ModuleInstance<
      BaseParamsFields & {
          account?: AccountInstance
          | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<ModuleConfig>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
          publicChildren?: (
              ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>
          )[];
      },
      ModuleEventData<object>,
  >
Parameters
- id: string
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<undefined | T>
Inherited from AbstractDiviner.resolvePrivate
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:39

`Protected`sendQuery

sendQuery<
    T extends Query,
    P extends Payload = Payload,
    R extends Payload = Payload,
>(
    queryPayload: T,
    payloads?: P[],
    account?: AccountInstance,
): Promise<R[]>
Type Parameters
- T extends Query
- P extends Payload = Payload
- R extends Payload = Payload
Parameters
- queryPayload: T
- Optionalpayloads: P[]
- Optionalaccount: AccountInstance
Returns Promise<R[]>
Inherited from AbstractDiviner.sendQuery
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:46

`Protected`sendQueryRaw

sendQueryRaw<
    T extends Query,
    P extends Payload = Payload,
    R extends Payload = Payload,
>(
    queryPayload: T,
    payloads?: P[],
    account?: AccountInstance,
): Promise<ModuleQueryResult<R>>
Type Parameters
- T extends Query
- P extends Payload = Payload
- R extends Payload = Payload
Parameters
- queryPayload: T
- Optionalpayloads: P[]
- Optionalaccount: AccountInstance
Returns Promise<ModuleQueryResult<R>>
Inherited from AbstractDiviner.sendQueryRaw
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:47

siblings

siblings(): Promise<
    ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
        },
        ModuleEventData<object>,
    >[],
>
Returns Promise<
    ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
            publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[];
        },
        ModuleEventData<object>,
    >[],
>
Inherited from AbstractDiviner.siblings
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:40

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/types/AbstractModule.d.ts:81

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/types/AbstractModule.d.ts:82

`Protected`startHandler

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

state

state(): Promise<Payload[]>
Returns Promise<Payload[]>
Inherited from AbstractDiviner.state
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:41

`Protected`stateHandler

stateHandler(): Promise<Payload[]>
Returns Promise<Payload[]>
Inherited from AbstractDiviner.stateHandler
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:102

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/types/AbstractModuleInstance.d.ts:42

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/types/AbstractModule.d.ts:83

`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/types/AbstractModule.d.ts:103

`Protected`storeToArchivists

storeToArchivists(payloads: Payload[]): Promise<Payload[]>
Parameters
- payloads: Payload[]
Returns Promise<Payload[]>
Inherited from AbstractDiviner.storeToArchivists
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModuleInstance.d.ts:48

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

`Protected`subscribeHandler

subscribeHandler(): void
Returns void
Inherited from AbstractDiviner.subscribeHandler
- Defined in packages/modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:104

`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/types/AbstractModule.d.ts:105

`Static`_getRootFunction

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

`Static`_noOverride

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

`Static`create

create<
    TModule extends
        AttachableModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    (
                        BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                    ),
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    (
                        BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                    ),
                    ModuleEventData<object>,
                >[];
            },
            ModuleEventData<object>,
        >,
>(
    this: CreatableModule<TModule>,
    params: Omit<TModule["params"], "config"> & {
        config?: TModule["params"]["config"];
    },
): Promise<TModule>
Type Parameters
- TModule extends AttachableModuleInstance<
      BaseParamsFields & {
          account?: AccountInstance
          | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<ModuleConfig>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: ModuleInstance<
              (
                  BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
              ),
              ModuleEventData<object>,
          >[];
          publicChildren?: ModuleInstance<
              (
                  BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
              ),
              ModuleEventData<object>,
          >[];
      },
      ModuleEventData<object>,
  >
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/types/AbstractModule.d.ts:64

`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/types/AbstractModule.d.ts:67

`Static`factory

factory<
    TModule extends
        AttachableModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig>;
                ephemeralQueryAccountEnabled?: boolean;
                moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                privateChildren?: ModuleInstance<
                    (
                        BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                    ),
                    ModuleEventData<object>,
                >[];
                publicChildren?: ModuleInstance<
                    (
                        BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                    ),
                    ModuleEventData<object>,
                >[];
            },
            ModuleEventData<object>,
        >,
>(
    this: CreatableModule<TModule>,
    params: Omit<TModule["params"], "config"> & {
        config?: TModule["params"]["config"];
    },
): CreatableModuleFactory<TModule>
Type Parameters
- TModule extends AttachableModuleInstance<
      BaseParamsFields & {
          account?: AccountInstance
          | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<ModuleConfig>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: ModuleInstance<
              (
                  BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
              ),
              ModuleEventData<object>,
          >[];
          publicChildren?: ModuleInstance<
              (
                  BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
              ),
              ModuleEventData<object>,
          >[];
      },
      ModuleEventData<object>,
  >
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/types/AbstractModule.d.ts:72

`Static`gc

gc(force?: boolean): void
Parameters
- Optionalforce: boolean
Returns void
Inherited from AbstractDiviner.gc
- Defined in node_modules/.store/@xylabs-object-npm-4.7.15-999645f30f/package/dist/types/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.7.15-999645f30f/package/dist/types/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.7.15-999645f30f/package/dist/types/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.7.15-999645f30f/package/dist/types/Base.d.ts:32

`Static`startHistory

startHistory(): void
Returns void
Inherited from AbstractDiviner.startHistory
- Defined in node_modules/.store/@xylabs-object-npm-4.7.15-999645f30f/package/dist/types/Base.d.ts:33

`Static`stopHistory

stopHistory(): void
Returns void
Inherited from AbstractDiviner.stopHistory
- Defined in node_modules/.store/@xylabs-object-npm-4.7.15-999645f30f/package/dist/types/Base.d.ts:34

Class JsonPathAggregateDiviner<TParams, TIn, TOut, TEventData>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns JsonPathAggregateDiviner<TParams, TIn, TOut, TEventData>

Properties

Protected_account

Protected_cachedManifests

Protected_globalReentrancyMutex

Protected Optional_lastError

Protected_started

Protected_startPromise

Protected_transforms

eventData

Protected ReadonlymoduleConfigQueryValidator

Protected ReadonlysupportedQueryValidator

Static ReadonlyallowRandomAccount

Static ReadonlyconfigSchemas

Static ReadonlydefaultConfigSchema

StaticdefaultLogger

StaticenableLazyLoad

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

Static Readonlylabels

Protected StaticprivateConstructorKey

Static ReadonlytargetSchema

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

ProtecteddestinationSchema

Returns string

downResolver

Returns CompositeModuleResolver<CompositeModuleResolverParams>

ephemeralQueryAccountEnabled

Returns boolean

globalReentrancyMutex

Returns undefined | Mutex

id

Returns string

logger

Returns Logger

modName

Returns undefined | string

moduleIdentifierTransformers

Returns ModuleIdentifierTransformer[]

params

Returns TParams

ProtectedpayloadTransformers

Returns SchemaToPayloadTransformersDictionary

priority

Returns 2

privateResolver

Returns CompositeModuleResolver<CompositeModuleResolverParams>

queries

`Protected`_account

`Protected`_cachedManifests

`Protected`_globalReentrancyMutex

`Protected` `Optional`_lastError

`Protected`_started

`Protected`_startPromise

`Protected`_transforms

`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` `Readonly`labels

`Protected` `Static`privateConstructorKey

`Static` `Readonly`targetSchema

`Static` `Readonly`uniqueName

`Static` `Readonly`useNewResolver

`Protected`destinationSchema

`Protected`payloadTransformers

`Protected`schemaTransforms

`Protected`transformableSchemas

`Static`historyInterval

`Static`historyTime

`Static`maxGcFrequency

`Static`maxHistoryDepth

`Protected`_checkDead

`Protected`_noOverride

`Protected`archivistInstance

`Protected`bindHashes

`Protected`bindHashesInternal

`Protected`bindQuery

`Protected`bindQueryInternal

`Protected`bindQueryResult