Class ModuleProxyResolver<T>

Type Parameters

T extends ModuleProxyResolverOptions = ModuleProxyResolverOptions

Implements

ModuleResolverInstance

Index

Constructors

constructor

new ModuleProxyResolver<
T extends ModuleProxyResolverOptions = ModuleProxyResolverOptions,
>(
options: T,
): ModuleProxyResolver<T>
Type Parameters
- T extends ModuleProxyResolverOptions = ModuleProxyResolverOptions
Parameters
- options: T
Returns ModuleProxyResolver<T>
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:186

Accessors

`Protected`childAddressMap

get childAddressMap(): Record<Lowercase<string>, null | string>
Returns Record<Lowercase<string>, null | string>
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:232

`Protected`host

get host(): ModuleResolver<
    ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    consoleLogger?: any;
                    labels?: { [x: string]: undefined | string };
                    name?: string;
                    paging?: { [x: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: string;
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: { [x: string]: (...)[] };
                        disallowed?: { [x: string]: (...)[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    timestamp?: boolean;
                },
            >;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
        },
    >,
>
Returns ModuleResolver<
    ModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    consoleLogger?: any;
                    labels?: { [x: string]: undefined | string };
                    name?: string;
                    paging?: { [x: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: string;
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: { [x: string]: (...)[] };
                        disallowed?: { [x: string]: (...)[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    timestamp?: boolean;
                },
            >;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
        },
    >,
>
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:233

`Protected`mod

get mod(): ModuleInstance<
    BaseParamsFields & {
        account?: AccountInstance
        | "random";
        additionalSigners?: AccountInstance[];
        addToResolvers?: boolean;
        allowNameResolution?: boolean;
        config: DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: any;
                labels?: { [x: string]: undefined | string };
                name?: string;
                paging?: { [x: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: string;
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [x: string]: ((...) | (...))[] };
                    disallowed?: { [x: string]: Lowercase<(...)>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >;
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    },
>
Returns ModuleInstance<
    BaseParamsFields & {
        account?: AccountInstance
        | "random";
        additionalSigners?: AccountInstance[];
        addToResolvers?: boolean;
        allowNameResolution?: boolean;
        config: DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: any;
                labels?: { [x: string]: undefined | string };
                name?: string;
                paging?: { [x: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: string;
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [x: string]: ((...) | (...))[] };
                    disallowed?: { [x: string]: Lowercase<(...)>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >;
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    },
>
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:277

priority

get priority(): 0
Returns 0
Implementation of ModuleResolverInstance.priority
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:187

root

get root(): ModuleInstance<
    BaseParamsFields & {
        account?: AccountInstance
        | "random";
        additionalSigners?: AccountInstance[];
        addToResolvers?: boolean;
        allowNameResolution?: boolean;
        config: DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: any;
                labels?: { [x: string]: undefined | string };
                name?: string;
                paging?: { [x: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: string;
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [x: string]: ((...) | (...))[] };
                    disallowed?: { [x: string]: Lowercase<(...)>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >;
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    },
>
Returns ModuleInstance<
    BaseParamsFields & {
        account?: AccountInstance
        | "random";
        additionalSigners?: AccountInstance[];
        addToResolvers?: boolean;
        allowNameResolution?: boolean;
        config: DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: any;
                labels?: { [x: string]: undefined | string };
                name?: string;
                paging?: { [x: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: string;
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [x: string]: ((...) | (...))[] };
                    disallowed?: { [x: string]: Lowercase<(...)>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >;
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    },
>
Implementation of ModuleResolverInstance.root
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:188

Methods

addResolver

addResolver(_resolver: ModuleResolver): this
Parameters
- _resolver: ModuleResolver
Returns this
Implementation of ModuleResolverInstance.addResolver
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:321

childManifest

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

childState

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

removeResolver

removeResolver(_resolver: ModuleResolver): this
Parameters
- _resolver: ModuleResolver
Returns this
Implementation of ModuleResolverInstance.removeResolver
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:408

resolve

resolve(): Promise<ModuleInstance[]>
Returns Promise<ModuleInstance[]>
Implementation of ModuleResolverInstance.resolve
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:409
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[]>
Implementation of ModuleResolverInstance.resolve
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:410
resolve<T extends ModuleInstance = ModuleInstance>(
filter: ModuleFilter<T>,
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- filter: ModuleFilter<T>
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Implementation of ModuleResolverInstance.resolve
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:411
resolve<T extends ModuleInstance = ModuleInstance>(
id: string,
options?: ModuleFilterOptions<T>,
): Promise<undefined | T>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- id: string
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<undefined | T>
Implementation of ModuleResolverInstance.resolve
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:412
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[]>
Implementation of ModuleResolverInstance.resolve
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:413

resolveIdentifier

resolveIdentifier(
id: string,
_options?: ObjectFilterOptions,
): Promisable<undefined | Lowercase<string>>
Parameters
- id: string
- Optional_options: ObjectFilterOptions
Returns Promisable<undefined | Lowercase<string>>
Implementation of ModuleResolverInstance.resolveIdentifier
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:414

resolvePrivate

resolvePrivate<T extends ModuleInstance = ModuleInstance>(
all: "*",
options?: ObjectFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- all: "*"
- Optionaloptions: ObjectFilterOptions<T>
Returns Promise<T[]>
Implementation of ModuleResolverInstance.resolvePrivate
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:415
resolvePrivate<T extends ModuleInstance = ModuleInstance>(
id: string,
options?: ObjectFilterOptions<T>,
): Promise<undefined | T>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- id: string
- Optionaloptions: ObjectFilterOptions<T>
Returns Promise<undefined | T>
Implementation of ModuleResolverInstance.resolvePrivate
- Defined in packages/modules/packages/bridge/packages/abstract/dist/neutral/index.d.ts:416

Class ModuleProxyResolver<T>

Type Parameters

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ModuleProxyResolver<T>

Accessors

ProtectedchildAddressMap

Returns Record<Lowercase<string>, null | string>

Protectedhost

Protectedmod

priority

Returns 0

root

Methods

addResolver

Parameters

Returns this

childManifest

Parameters

childState

Parameters

removeResolver

Parameters

Returns this

resolve

Returns Promise<ModuleInstance[]>

Type Parameters

Parameters

Returns Promise<T[]>

Type Parameters

Parameters

Returns Promise<T[]>

Type Parameters

Parameters

Returns Promise<undefined | T>

Type Parameters

Parameters

Returns Promise<T[]>

resolveIdentifier

Parameters

Returns Promisable<undefined | Lowercase<string>>

resolvePrivate

Type Parameters

Parameters

Returns Promise<T[]>

Type Parameters

Parameters

Returns Promise<undefined | T>

Settings

On This Page

`Protected`childAddressMap

`Protected`host

`Protected`mod