Class AbstractModule<TParams, TEventData>`Abstract`

Index

Constructors

constructor

Properties

_account _cachedManifests _globalReentrancyMutex _lastError? _started _startPromise eventData moduleConfigQueryValidator supportedQueryValidator allowRandomAccount configSchemas defaultConfigSchema defaultLogger enableLazyLoad globalInstances globalInstancesCountHistory labels privateConstructorKey uniqueName

Constructors

constructor

new AbstractModule<
    TParams extends
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig<void, void>>;
            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>,
            >[];
        } = BaseParamsFields & {
        account?: AccountInstance
        | "random";
        additionalSigners?: AccountInstance[];
        addToResolvers?: boolean;
        allowNameResolution?: boolean;
        config: AnyConfigSchema<ModuleConfig<void, void>>;
        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>,
        >[];
    },
    TEventData extends ModuleEventData<object> = ModuleEventData<object>,
>(
    privateConstructorKey: string,
    params: TParams,
    account: AccountInstance,
): AbstractModule<TParams, TEventData>
Type Parameters
- TParams extends BaseParamsFields & {
      account?: AccountInstance | "random";
      additionalSigners?: AccountInstance[];
      addToResolvers?: boolean;
      allowNameResolution?: boolean;
      config: AnyConfigSchema<ModuleConfig<void, void>>;
      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>,
      >[];
  } = BaseParamsFields & {
      account?: AccountInstance | "random";
      additionalSigners?: AccountInstance[];
      addToResolvers?: boolean;
      allowNameResolution?: boolean;
      config: AnyConfigSchema<ModuleConfig<void, void>>;
      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>,
      >[];
  }
- TEventData extends ModuleEventData<object> = ModuleEventData<object>
Parameters
- privateConstructorKey: string
- params: TParams
- account: AccountInstance
Returns AbstractModule<TParams, TEventData>
Overrides BaseEmitter.constructor
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:67

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>

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

`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`uniqueName

uniqueName: string

Accessors

account

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

additionalSigners

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

address

get address(): Lowercase<string>
Returns Lowercase<string>
Implementation of Module.address
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:70

allowAnonymous

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

allowNameResolution

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

archiving

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

archivist

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

config

get config(): TParams["config"]
Returns TParams["config"]
Implementation of Module.config
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:75

dead

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

`Abstract`downResolver

get downResolver(): ModuleResolverInstance
Returns ModuleResolverInstance
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:91

ephemeralQueryAccountEnabled

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

globalReentrancyMutex

get globalReentrancyMutex(): undefined | Mutex
Returns undefined | Mutex
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:78

id

get id(): string
Returns string
Implementation of Module.id
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:79

logger

get logger(): Logger
Returns Logger
Overrides BaseEmitter.logger
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:80

modName

get modName(): undefined | string
Returns undefined | string
Implementation of Module.modName
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:81

params

get params(): TParams
Returns TParams
Implementation of Module.params
Inherited from BaseEmitter.params
- Defined in node_modules/.store/@xylabs-object-npm-4.5.1-e31c389195/package/dist/neutral/Base.d.ts:28

priority

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

queries

get queries(): string[]
Returns string[]
Implementation of Module.queries
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:83

reentrancy

get reentrancy(): undefined | { action: "skip" | "wait"; scope: "global" }
Returns undefined | { action: "skip" | "wait"; scope: "global" }
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:84

status

get status(): ModuleStatus
Returns ModuleStatus
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:88
set status(value: ModuleStatus): void
Parameters
- value: ModuleStatus
Returns void
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:90

timestamp

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

`Abstract`upResolver

get upResolver(): ModuleResolverInstance
Returns ModuleResolverInstance
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:92

`Static`historyInterval

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

`Static`historyTime

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

`Static`maxGcFrequency

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

`Static`maxHistoryDepth

get maxHistoryDepth(): number
Returns number
Inherited from BaseEmitter.maxHistoryDepth
- Defined in node_modules/.store/@xylabs-object-npm-4.5.1-e31c389195/package/dist/neutral/Base.d.ts:26

Methods

`Protected`_checkDead

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

_getRootFunction

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

`Protected`_noOverride

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

`Protected`archivistInstance

archivistInstance(): Promise<
    | undefined
    | ArchivistInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ArchivistConfig<void, void>>;
            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<void, void>>;
            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,
    >,
>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:117
archivistInstance(
    required: true,
): Promise<
    ArchivistInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ArchivistConfig<void, void>>;
            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<void, void>>;
            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,
    >,
>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:118

`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>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:119

`Protected`bindHashesInternal

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

`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>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:121

`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[]]>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:122

`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>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:123

busy

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

`Protected` `Abstract`certifyParents

certifyParents(): Promise<Payload[]>
Returns Promise<Payload[]>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:136

clearListeners

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

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>
Implementation of Module.emit
Overrides BaseEmitter.emit
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:108

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>
Implementation of Module.emitSerial
Inherited from BaseEmitter.emitSerial
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:10

`Protected`generateConfigAndAddress

generateConfigAndAddress(_maxDepth?: number): Promisable<Payload[]>
Parameters
- Optional_maxDepth: number
Returns Promisable<Payload[]>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:124

`Protected`generateDescribe

generateDescribe(): Promise<ModuleDescriptionPayload>
Returns Promise<ModuleDescriptionPayload>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:125

`Protected`getArchivist

getArchivist(): Promise<
    | undefined
    | ArchivistInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ArchivistConfig<void, void>>;
            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<void, void>>;
            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,
    >,
>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:126

`Protected`isAllowedArchivingQuery

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

listenerCount

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

`Protected`manifestHandler

manifestHandler(
_maxDepth?: number,
_ignoreAddresses?: Lowercase<string>[],
): Promisable<ModuleManifestPayload>
Parameters
- Optional_maxDepth: number
- Optional_ignoreAddresses: Lowercase<string>[]
Returns Promisable<ModuleManifestPayload>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:128

`Protected`moduleAddressHandler

moduleAddressHandler(): Promisable<
(AddressPreviousHashPayload | AddressPayload)[],
>
Returns Promisable<(AddressPreviousHashPayload | AddressPayload)[]>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:129

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
Implementation of Module.off
Inherited from BaseEmitter.off
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:12

offAny

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

on

on<TEventName extends string | number | symbol>(
eventNames: TEventName | TEventName[],
listener: EventListener<TEventData[TEventName]>,
): () => void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns () => void
Implementation of Module.on
Inherited from BaseEmitter.on
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:14

onAny

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

once

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

previousHash

previousHash(): Promisable<undefined | string>
Returns Promisable<undefined | string>
Implementation of Module.previousHash
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:109

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>
Implementation of Module.query
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:110

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>
Implementation of Module.queryable
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:111

`Protected`queryHandler

queryHandler<
    T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
    TConfig extends ModuleConfig = ModuleConfig,
>(
    query: T,
    payloads?: Payload[],
    queryConfig?: TConfig,
): Promise<ModuleQueryHandlerResult>
Type Parameters
- T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
- TConfig extends ModuleConfig = ModuleConfig
Parameters
- query: T
- Optionalpayloads: Payload[]
- OptionalqueryConfig: TConfig
Returns Promise<ModuleQueryHandlerResult>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:130

start

start(_timeout?: number): Promisable<boolean>
Parameters
- Optional_timeout: number
Returns Promisable<boolean>
Implementation of Module.start
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:112

started

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

`Protected`startHandler

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

`Protected`stateHandler

stateHandler(): Promise<Payload[]>
Returns Promise<Payload[]>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:132

stop

stop(_timeout?: number): Promise<boolean>
Parameters
- Optional_timeout: number
Returns Promise<boolean>
Implementation of Module.stop
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:114

`Protected`stopHandler

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

`Protected` `Abstract`storeToArchivists

storeToArchivists(payloads: Payload[]): Promise<Payload[]>
Parameters
- payloads: Payload[]
Returns Promise<Payload[]>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:137

`Protected`subscribeHandler

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

`Protected`validateConfig

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

`Static`_getRootFunction

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

`Static`_noOverride

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

`Static`create

create<
    TModule extends
        AttachableModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                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<void, void>>;
          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>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:95

`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>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:98

`Static`factory

factory<
    TModule extends
        AttachableModuleInstance<
            BaseParamsFields & {
                account?: AccountInstance
                | "random";
                additionalSigners?: AccountInstance[];
                addToResolvers?: boolean;
                allowNameResolution?: boolean;
                config: AnyConfigSchema<ModuleConfig<void, void>>;
                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<void, void>>;
          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>
- Defined in packages/modules/packages/module/packages/abstract/dist/neutral/index.d.ts:103

`Static`gc

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

`Static`instanceCount

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

`Static`instanceCounts

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

`Static`startHistory

startHistory(): void
Returns void
Inherited from BaseEmitter.startHistory
- Defined in node_modules/.store/@xylabs-object-npm-4.5.1-e31c389195/package/dist/neutral/Base.d.ts:33

`Static`stopHistory

stopHistory(): void
Returns void
Inherited from BaseEmitter.stopHistory
- Defined in node_modules/.store/@xylabs-object-npm-4.5.1-e31c389195/package/dist/neutral/Base.d.ts:34

Class AbstractModule<TParams, TEventData>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbstractModule<TParams, TEventData>

Properties

Protected_account

Protected_cachedManifests

Protected_globalReentrancyMutex

Protected Optional_lastError

Protected_started

Protected_startPromise

eventData

Protected ReadonlymoduleConfigQueryValidator

Protected ReadonlysupportedQueryValidator

Static ReadonlyallowRandomAccount

Static ReadonlyconfigSchemas

Static ReadonlydefaultConfigSchema

StaticdefaultLogger

StaticenableLazyLoad

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

Static Readonlylabels

Protected StaticprivateConstructorKey

Static ReadonlyuniqueName

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

AbstractdownResolver

Returns ModuleResolverInstance

ephemeralQueryAccountEnabled

Returns boolean

globalReentrancyMutex

Returns undefined | Mutex

id

Returns string

logger

Returns Logger

modName

Returns undefined | string

params

Returns TParams

priority

Returns 2

queries

Returns string[]

reentrancy

Returns undefined | { action: "skip" | "wait"; scope: "global" }

status

Returns ModuleStatus

Parameters

Returns void

timestamp

Returns boolean

AbstractupResolver

Class AbstractModule<TParams, TEventData>`Abstract`

`Protected`_account

`Protected`_cachedManifests

`Protected`_globalReentrancyMutex

`Protected` `Optional`_lastError

`Protected`_started

`Protected`_startPromise

`Protected` `Readonly`moduleConfigQueryValidator

`Protected` `Readonly`supportedQueryValidator

`Static` `Readonly`allowRandomAccount

`Static` `Readonly`configSchemas

`Static` `Readonly`defaultConfigSchema

`Static`defaultLogger

`Static`enableLazyLoad

`Static` `Readonly`globalInstances

`Static` `Readonly`globalInstancesCountHistory

`Static` `Readonly`labels

`Protected` `Static`privateConstructorKey

`Static` `Readonly`uniqueName

`Abstract`downResolver

`Abstract`upResolver

`Static`historyInterval

`Static`historyTime

`Static`maxGcFrequency

`Static`maxHistoryDepth

`Protected`_checkDead

`Protected`_noOverride

`Protected`archivistInstance

`Protected`bindHashes

`Protected`bindHashesInternal

`Protected`bindQuery

`Protected`bindQueryInternal

`Protected`bindQueryResult

`Protected` `Abstract`certifyParents

`Protected`generateConfigAndAddress

`Protected`generateDescribe

`Protected`getArchivist