Class ModuleWrapper<TWrappedModule>

Type Parameters

TWrappedModule extends Module = Module

Hierarchy (View Summary)

Base<
    Exclude<
        Omit<TWrappedModule["params"], "config"> & {
            config: Exclude<TWrappedModule["params"]["config"], undefined>;
        },
        undefined,
    >,
>
- ModuleWrapper

Implements

AttachableModuleInstance<TWrappedModule["params"], TWrappedModule["eventData"]>

Index

Constructors

constructor

new ModuleWrapper<TWrappedModule extends Module = Module>(
params: ModuleWrapperParams<TWrappedModule>,
): ModuleWrapper<TWrappedModule>
Type Parameters
- TWrappedModule extends Module = Module
Parameters
- params: ModuleWrapperParams<TWrappedModule>
Returns ModuleWrapper<TWrappedModule>
Overrides Base.constructor
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:103

Properties

`Protected` `Readonly`cachedCalls

cachedCalls: LRUCache<string, DeepRestrictToStringKeys<{ schema: string }>[]> = ...

eventData

eventData: TWrappedModule["eventData"] = ...

`Protected` `Readonly`wrapperParams

wrapperParams: ModuleWrapperParams<TWrappedModule>

`Static` `Optional`defaultLogger

defaultLogger?: Logger

`Static` `Readonly`globalInstances

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

`Static` `Readonly`globalInstancesCountHistory

globalInstancesCountHistory: Record<string, number[]>

`Static`instanceIdentityCheck

instanceIdentityCheck: InstanceTypeCheck = isModuleInstance

`Static`moduleIdentityCheck

moduleIdentityCheck: ModuleTypeCheck = isModule

`Static`requiredQueries

requiredQueries: string[] = ...

`Static` `Readonly`uniqueName

uniqueName: string

Accessors

account

get account(): AccountInstance
Returns AccountInstance
Implementation of AttachableModuleInstance.account
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:115

additionalSigners

get additionalSigners(): AccountInstance[]
Returns AccountInstance[]
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:119

address

get address(): Lowercase<string>
Returns Lowercase<string>
Implementation of AttachableModuleInstance.address
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:123

config

get config(): Exclude<TWrappedModule["params"]["config"], undefined>
Returns Exclude<TWrappedModule["params"]["config"], undefined>
Implementation of AttachableModuleInstance.config
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:127

downResolver

get downResolver(): ModuleResolverInstance
Returns ModuleResolverInstance
Implementation of AttachableModuleInstance.downResolver
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:131

id

get id(): string
Returns string
Implementation of AttachableModuleInstance.id
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:140

logger

get logger(): undefined | Logger
Returns undefined | Logger
Inherited from Base.logger
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:27

mod

get mod(): TWrappedModule
Returns TWrappedModule
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:144

modName

get modName(): undefined | string
Returns undefined | string
Implementation of AttachableModuleInstance.modName
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:148

params

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

priority

get priority(): 1
Returns 1
Implementation of AttachableModuleInstance.priority
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:152

privateResolver

get privateResolver(): ModuleResolverInstance
Returns ModuleResolverInstance
Implementation of AttachableModuleInstance.privateResolver
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:156

queries

get queries(): string[]
Returns string[]
Implementation of AttachableModuleInstance.queries
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:165

status

get status(): ModuleStatus
Returns ModuleStatus
Implementation of AttachableModuleInstance.status
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:169
set status(value: ModuleStatus): void
Parameters
- value: ModuleStatus
Returns void
Implementation of AttachableModuleInstance.status
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:182

upResolver

get upResolver(): ModuleResolverInstance
Returns ModuleResolverInstance
Implementation of AttachableModuleInstance.upResolver
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:173

`Static`historyInterval

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

`Static`historyTime

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

`Static`maxGcFrequency

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

`Static`maxHistoryDepth

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

Methods

addParent

addParent(mod: ModuleInstance): void
Parameters
- mod: ModuleInstance
Returns void
Implementation of AttachableModuleInstance.addParent
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:247

addressPreviousHash

addressPreviousHash(): Promise<
    DeepRestrictToStringKeys<
        {
            address: Lowercase<string>;
            previousHash?: string;
            schema: "network.xyo.address.hash.previous";
        },
    >,
>
Returns Promise<
    DeepRestrictToStringKeys<
        {
            address: Lowercase<string>;
            previousHash?: string;
            schema: "network.xyo.address.hash.previous";
        },
    >,
>
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:254

`Protected`bindQuery

bindQuery<
    T extends
        DeepRestrictToStringKeys<
            {
                address?: Lowercase<string>
                | Lowercase<string>[];
                budget?: number;
                maxFrequency?:
                    | "once"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "year";
                minBid?: number;
                schema: string;
            },
        >,
>(
    query: T,
    payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
    account?: AccountInstance,
    additionalSigners?: AccountInstance[],
): PromiseEx<
    [
        UnsignedQueryBoundWitness,
        DeepRestrictToStringKeys<{ schema: string }>[],
        DeepRestrictToStringKeys<
            {
                details?: | null
                | string
                | number
                | boolean
                | {
                    [key: string]: | null
                    | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[];
                }
                | (
                    | null
                    | string
                    | number
                    | boolean
                    | {
                        [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                    }
                    | (
                        (string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null)[]
                    )
                )[];
                message?: string;
                name?: string;
                query?: Lowercase<string>;
                schema: "network.xyo.error.module";
            },
        >[],
    ],
    AccountInstance,
>
Type Parameters
- T extends DeepRestrictToStringKeys<
      {
          address?: Lowercase<string>
          | Lowercase<string>[];
          budget?: number;
          maxFrequency?:
              | "once"
              | "second"
              | "minute"
              | "hour"
              | "day"
              | "week"
              | "month"
              | "year";
          minBid?: number;
          schema: string;
      },
  >
Parameters
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- account: AccountInstance = ...
- additionalSigners: AccountInstance[] = ...
Returns PromiseEx<
    [
        UnsignedQueryBoundWitness,
        DeepRestrictToStringKeys<{ schema: string }>[],
        DeepRestrictToStringKeys<
            {
                details?: | null
                | string
                | number
                | boolean
                | {
                    [key: string]: | null
                    | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[];
                }
                | (
                    | null
                    | string
                    | number
                    | boolean
                    | {
                        [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                    }
                    | (
                        (string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null)[]
                    )
                )[];
                message?: string;
                name?: string;
                query?: Lowercase<string>;
                schema: "network.xyo.error.module";
            },
        >[],
    ],
    AccountInstance,
>
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:419

`Protected`bindQueryInternal

bindQueryInternal<
    T extends
        DeepRestrictToStringKeys<
            {
                address?: Lowercase<string>
                | Lowercase<string>[];
                budget?: number;
                maxFrequency?:
                    | "once"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "year";
                minBid?: number;
                schema: string;
            },
        >,
>(
    query: T,
    payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
    account?: AccountInstance,
    additionalSigners?: AccountInstance[],
): Promise<
    [
        UnsignedQueryBoundWitness,
        DeepRestrictToStringKeys<{ schema: string }>[],
        DeepRestrictToStringKeys<
            {
                details?: | null
                | string
                | number
                | boolean
                | {
                    [key: string]: | null
                    | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[];
                }
                | (
                    | null
                    | string
                    | number
                    | boolean
                    | {
                        [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                    }
                    | (
                        (string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null)[]
                    )
                )[];
                message?: string;
                name?: string;
                query?: Lowercase<string>;
                schema: "network.xyo.error.module";
            },
        >[],
    ],
>
Type Parameters
- T extends DeepRestrictToStringKeys<
      {
          address?: Lowercase<string>
          | Lowercase<string>[];
          budget?: number;
          maxFrequency?:
              | "once"
              | "second"
              | "minute"
              | "hour"
              | "day"
              | "week"
              | "month"
              | "year";
          minBid?: number;
          schema: string;
      },
  >
Parameters
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- account: AccountInstance = ...
- additionalSigners: AccountInstance[] = ...
Returns Promise<
    [
        UnsignedQueryBoundWitness,
        DeepRestrictToStringKeys<{ schema: string }>[],
        DeepRestrictToStringKeys<
            {
                details?: | null
                | string
                | number
                | boolean
                | {
                    [key: string]: | null
                    | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[];
                }
                | (
                    | null
                    | string
                    | number
                    | boolean
                    | {
                        [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                    }
                    | (
                        (string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null)[]
                    )
                )[];
                message?: string;
                name?: string;
                query?: Lowercase<string>;
                schema: "network.xyo.error.module";
            },
        >[],
    ],
>
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:433

clearListeners

clearListeners(
eventNames: Parameters<TWrappedModule["clearListeners"]>[0],
): void
Parameters
- eventNames: Parameters<TWrappedModule["clearListeners"]>[0]
Returns void
Implementation of AttachableModuleInstance.clearListeners
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:262

emit

emit(
eventName: Parameters<TWrappedModule["emit"]>[0],
eventArgs: Parameters<TWrappedModule["emit"]>[1],
): Promise<void>
Parameters
- eventName: Parameters<TWrappedModule["emit"]>[0]
- eventArgs: Parameters<TWrappedModule["emit"]>[1]
Returns Promise<void>
Implementation of AttachableModuleInstance.emit
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:266

emitSerial

emitSerial(
eventName: Parameters<TWrappedModule["emitSerial"]>[0],
eventArgs: Parameters<TWrappedModule["emitSerial"]>[1],
): Promise<void>
Parameters
- eventName: Parameters<TWrappedModule["emitSerial"]>[0]
- eventArgs: Parameters<TWrappedModule["emitSerial"]>[1]
Returns Promise<void>
Implementation of AttachableModuleInstance.emitSerial
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:270

`Protected`filterErrors

filterErrors(
    result: ModuleQueryResult,
): Promise<
    DeepRestrictToStringKeys<
        {
            details?: | null
            | string
            | number
            | boolean
            | {
                [key: string]: | null
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[];
            }
            | (
                | null
                | string
                | number
                | boolean
                | {
                    [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                }
                | (
                    (string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null)[]
                )
            )[];
            message?: string;
            name?: string;
            query?: Lowercase<string>;
            schema: "network.xyo.error.module";
        },
    >[],
>
Parameters
- result: ModuleQueryResult
Returns Promise<
    DeepRestrictToStringKeys<
        {
            details?: | null
            | string
            | number
            | boolean
            | {
                [key: string]: | null
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[];
            }
            | (
                | null
                | string
                | number
                | boolean
                | {
                    [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                }
                | (
                    (string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null)[]
                )
            )[];
            message?: string;
            name?: string;
            query?: Lowercase<string>;
            schema: "network.xyo.error.module";
        },
    >[],
>
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:444

listenerCount

listenerCount(
eventNames: Parameters<TWrappedModule["listenerCount"]>[0],
): number
Parameters
- eventNames: Parameters<TWrappedModule["listenerCount"]>[0]
Returns number
Implementation of AttachableModuleInstance.listenerCount
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:274

manifest

manifest(
    maxDepth?: number,
): Promise<
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.module.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.node.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >,
>
Parameters
- OptionalmaxDepth: number
Returns Promise<
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.module.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.node.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        },
    >,
>
Implementation of AttachableModuleInstance.manifest
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:278

manifestQuery

manifestQuery(
    account: AccountInstance,
    maxDepth?: number,
): Promise<
    ModuleQueryResult<
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.module.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.node.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >,
    >,
>
Parameters
- account: AccountInstance
- OptionalmaxDepth: number
Returns Promise<
    ModuleQueryResult<
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.module.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.node.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >,
    >,
>
Implementation of AttachableModuleInstance.manifestQuery
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:283

moduleAddress

moduleAddress(): Promise<
    DeepRestrictToStringKeys<
        {
            address: Lowercase<string>;
            previousHash?: string;
            schema: "network.xyo.address.hash.previous";
        },
    >[],
>
Returns Promise<
    DeepRestrictToStringKeys<
        {
            address: Lowercase<string>;
            previousHash?: string;
            schema: "network.xyo.address.hash.previous";
        },
    >[],
>
Implementation of AttachableModuleInstance.moduleAddress
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:288

off

off<TEventName extends string | number | symbol>(
eventNames: TEventName,
listener: EventListener<TWrappedModule["eventData"][TEventName]>,
): void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName
- listener: EventListener<TWrappedModule["eventData"][TEventName]>
Returns void
Implementation of AttachableModuleInstance.off
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:293

offAny

offAny(listener: EventAnyListener): void
Parameters
- listener: EventAnyListener
Returns void
Implementation of AttachableModuleInstance.offAny
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:300

on

on<TEventName extends string | number | symbol>(
eventNames: TEventName,
listener: EventListener<TWrappedModule["eventData"][TEventName]>,
): EventUnsubscribeFunction
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName
- listener: EventListener<TWrappedModule["eventData"][TEventName]>
Returns EventUnsubscribeFunction
Implementation of AttachableModuleInstance.on
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:304

onAny

onAny(listener: EventAnyListener): EventUnsubscribeFunction
Parameters
- listener: EventAnyListener
Returns EventUnsubscribeFunction
Implementation of AttachableModuleInstance.onAny
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:308

once

once<TEventName extends string | number | symbol>(
eventName: TEventName,
listener: EventListener<TWrappedModule["eventData"][TEventName]>,
): EventUnsubscribeFunction
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- listener: EventListener<TWrappedModule["eventData"][TEventName]>
Returns EventUnsubscribeFunction
Implementation of AttachableModuleInstance.once
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:312

parents

parents(): Promisable<ModuleInstance[]>
Returns Promisable<ModuleInstance[]>
Implementation of AttachableModuleInstance.parents
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:319

previousHash

previousHash(): Promise<undefined | string>
Returns Promise<undefined | string>
Implementation of AttachableModuleInstance.previousHash
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:323

previousHashQuery

previousHashQuery(
    account?: AccountInstance,
): Promise<
    ModuleQueryResult<
        DeepRestrictToStringKeys<
            {
                address: Lowercase<string>;
                previousHash?: string;
                schema: "network.xyo.address.hash.previous";
            },
        >,
    >,
>
Parameters
- Optionalaccount: AccountInstance
Returns Promise<
    ModuleQueryResult<
        DeepRestrictToStringKeys<
            {
                address: Lowercase<string>;
                previousHash?: string;
                schema: "network.xyo.address.hash.previous";
            },
        >,
    >,
>
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:328

privateChildren

privateChildren(): Promise<ModuleInstance[]>
Returns Promise<ModuleInstance[]>
Implementation of AttachableModuleInstance.privateChildren
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:333

publicChildren

publicChildren(): Promise<ModuleInstance[]>
Returns Promise<ModuleInstance[]>
Implementation of AttachableModuleInstance.publicChildren
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:340

query

query<T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness>(
query: T,
payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
): Promise<ModuleQueryResult>
Type Parameters
- T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
Parameters
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
Returns Promise<ModuleQueryResult>
Implementation of AttachableModuleInstance.query
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:347

queryable

queryable<T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness>(
query: T,
payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
): Promisable<boolean>
Type Parameters
- T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
Parameters
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
Returns Promisable<boolean>
Implementation of AttachableModuleInstance.queryable
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:351

removeParent

removeParent(address: Lowercase<string>): void
Parameters
- address: Lowercase<string>
Returns void
Implementation of AttachableModuleInstance.removeParent
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:355

resolve

resolve<T extends ModuleInstance = ModuleInstance>(): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Returns Promise<T[]>
Deprecated
do not pass undefined. If trying to get all, pass '*'
Implementation of AttachableModuleInstance.resolve
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:360
resolve<T extends ModuleInstance = ModuleInstance>(
all: "*",
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- all: "*"
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Deprecated
do not pass undefined. If trying to get all, pass '*'
Implementation of AttachableModuleInstance.resolve
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:361
resolve<T extends ModuleInstance = ModuleInstance>(
filter: undefined | ModuleFilter<T>,
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- filter: undefined | ModuleFilter<T>
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Deprecated
do not pass undefined. If trying to get all, pass '*'
Implementation of AttachableModuleInstance.resolve
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:362
resolve<T extends ModuleInstance = ModuleInstance>(
id: string,
options?: ModuleFilterOptions<T>,
): Promise<ModuleInstance>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- id: string
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<ModuleInstance>
Deprecated
do not pass undefined. If trying to get all, pass '*'
Implementation of AttachableModuleInstance.resolve
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:363
resolve<T extends ModuleInstance = ModuleInstance>(
filter?: ModuleFilter<T>,
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- Optionalfilter: ModuleFilter<T>
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Deprecated
use '*' if trying to resolve all
Implementation of AttachableModuleInstance.resolve
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:368

resolvePrivate

resolvePrivate<T extends ModuleInstance = ModuleInstance>(
all: "*",
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- all: "*"
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Implementation of AttachableModuleInstance.resolvePrivate
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:390
resolvePrivate<T extends ModuleInstance = ModuleInstance>(
id: string,
options?: ModuleFilterOptions<T>,
): Promise<undefined | T>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- id: string
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<undefined | T>
Implementation of AttachableModuleInstance.resolvePrivate
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:391

`Protected`sendQuery

sendQuery<
    T extends
        DeepRestrictToStringKeys<
            {
                address?: Lowercase<string>
                | Lowercase<string>[];
                budget?: number;
                maxFrequency?:
                    | "once"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "year";
                minBid?: number;
                schema: string;
            },
        >,
    P extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
    R extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
>(
    queryPayload: T,
    payloads?: P[],
): Promise<R[]>
Type Parameters
- T extends DeepRestrictToStringKeys<
      {
          address?: Lowercase<string>
          | Lowercase<string>[];
          budget?: number;
          maxFrequency?:
              | "once"
              | "second"
              | "minute"
              | "hour"
              | "day"
              | "week"
              | "month"
              | "year";
          minBid?: number;
          schema: string;
      },
  >
- P extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
- R extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
Parameters
- queryPayload: T
- Optionalpayloads: P[]
Returns Promise<R[]>
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:449

`Protected`sendQueryRaw

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

siblings

siblings(): Promise<ModuleInstance[]>
Returns Promise<ModuleInstance[]>
Implementation of AttachableModuleInstance.siblings
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:399

state

state(): Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Returns Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Implementation of AttachableModuleInstance.state
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:403

stateQuery

stateQuery(_account: AccountInstance): Promise<ModuleQueryResult>
Parameters
- _account: AccountInstance
Returns Promise<ModuleQueryResult>
Implementation of AttachableModuleInstance.stateQuery
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:414

`Static`canWrap

canWrap(mod?: Module): mod is Module
Parameters
- Optionalmod: Module
Returns mod is Module
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:188

`Static`gc

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

`Static`hasRequiredQueries

hasRequiredQueries(mod: Module): boolean
Parameters
- mod: Module
Returns boolean
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:192

`Static`instanceCount

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

`Static`instanceCounts

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

`Static`is

is<TModuleWrapper extends ModuleWrapper>(
this: ConstructableModuleWrapper<TModuleWrapper>,
wrapper: any,
): wrapper is TModuleWrapper
Type Parameters
- TModuleWrapper extends ModuleWrapper
Parameters
- this: ConstructableModuleWrapper<TModuleWrapper>
- wrapper: any
Returns wrapper is TModuleWrapper
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:196

`Static`missingRequiredQueries

missingRequiredQueries(mod: Module): string[]
Parameters
- mod: Module
Returns string[]
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:204

`Static`startHistory

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

`Static`stopHistory

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

`Static`tryWrap

tryWrap<TModuleWrapper extends ModuleWrapper>(
    this: ConstructableModuleWrapper<TModuleWrapper>,
    mod: undefined | Module,
    account: AccountInstance,
    checkIdentity?: boolean,
): undefined | TModuleWrapper
Type Parameters
- TModuleWrapper extends ModuleWrapper
Parameters
- this: ConstructableModuleWrapper<TModuleWrapper>
- mod: undefined | Module
- account: AccountInstance
- checkIdentity: boolean = true
Returns undefined | TModuleWrapper
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:213

`Static`with

with<TModuleWrapper extends ModuleWrapper, R extends Promisable<void> = void>(
    this: ConstructableModuleWrapper<TModuleWrapper>,
    mod: any,
    closure: (mod: TModuleWrapper) => R,
): undefined | R
Type Parameters
- TModuleWrapper extends ModuleWrapper
- R extends Promisable<void> = void
Parameters
- this: ConstructableModuleWrapper<TModuleWrapper>
- mod: any
- closure: (mod: TModuleWrapper) => R
Returns undefined | R
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:227

`Static`wrap

wrap<TModuleWrapper extends ModuleWrapper>(
    this: ConstructableModuleWrapper<TModuleWrapper>,
    mod: undefined | Module,
    account: AccountInstance,
    checkIdentity?: boolean,
): TModuleWrapper
Type Parameters
- TModuleWrapper extends ModuleWrapper
Parameters
- this: ConstructableModuleWrapper<TModuleWrapper>
- mod: undefined | Module
- account: AccountInstance
- checkIdentity: boolean = true
Returns TModuleWrapper
- Defined in packages/modules/packages/module/packages/wrapper/src/ModuleWrapper.ts:237

Class ModuleWrapper<TWrappedModule>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ModuleWrapper<TWrappedModule>

Properties

Protected ReadonlycachedCalls

eventData

Protected ReadonlywrapperParams

Static OptionaldefaultLogger

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

StaticinstanceIdentityCheck

StaticmoduleIdentityCheck

StaticrequiredQueries

Static ReadonlyuniqueName

Accessors

account

Returns AccountInstance

additionalSigners

Returns AccountInstance[]

address

Returns Lowercase<string>

config

Returns Exclude<TWrappedModule["params"]["config"], undefined>

downResolver

Returns ModuleResolverInstance

id

Returns string

logger

Returns undefined | Logger

mod

Returns TWrappedModule

modName

Returns undefined | string

params

Returns TParams

priority

Returns 1

privateResolver

Returns ModuleResolverInstance

queries

Returns string[]

status

Returns ModuleStatus

Parameters

Returns void

upResolver

Returns ModuleResolverInstance

StatichistoryInterval

Returns number

Parameters

Returns void

StatichistoryTime

Returns number

Parameters

Returns void

StaticmaxGcFrequency

Returns number

Parameters

Returns void

StaticmaxHistoryDepth

Returns number

Methods

addParent

Parameters

Returns void

addressPreviousHash

Returns Promise< DeepRestrictToStringKeys< { address: Lowercase<string>; previousHash?: string; schema: "network.xyo.address.hash.previous"; }, >,>

ProtectedbindQuery

Type Parameters

`Protected` `Readonly`cachedCalls

`Protected` `Readonly`wrapperParams

`Static` `Optional`defaultLogger

`Static` `Readonly`globalInstances

`Static` `Readonly`globalInstancesCountHistory

`Static`instanceIdentityCheck

`Static`moduleIdentityCheck

`Static`requiredQueries

`Static` `Readonly`uniqueName

`Static`historyInterval

`Static`historyTime

`Static`maxGcFrequency

`Static`maxHistoryDepth

Returns Promise<
DeepRestrictToStringKeys<
{
address: Lowercase<string>;
previousHash?: string;
schema: "network.xyo.address.hash.previous";
},
>,
>

`Protected`bindQuery

`Protected`bindQueryInternal

`Protected`filterErrors

Returns Promise<
DeepRestrictToStringKeys<
{
address: Lowercase<string>;
previousHash?: string;
schema: "network.xyo.address.hash.previous";
},
>[],
>

Returns Promise<
ModuleQueryResult<
DeepRestrictToStringKeys<
{
address: Lowercase<string>;
previousHash?: string;
schema: "network.xyo.address.hash.previous";
},
>,
>,
>