Class BridgeModuleResolver

Hierarchy

Implements

Constructors

constructor

Properties

bridge params remoteAddresses? resolveByAddress resolveByName resolveByQuery resolveRemoteModules resolveRemoteModulesByAddress resolveRemoteModulesByName resolveRemoteModulesByQuery resolvedModules resolvers defaultLogger?

Accessors

isModuleResolver logger

Methods

add addResolver currentResolvedModules getRemoteAddresses remove removeResolver resolve resolveOne

Constructors

constructor

  • Parameters

    • bridge: BridgeModule<BridgeParams<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: "network.xyo.bridge.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<{
          discoverCache?: true | CacheConfig;
          schema: "network.xyo.bridge.config";
      }, "schema">, "schema"> & {
          schema: string;
      }, "schema">>, ModuleEventData, Module<ModuleParams<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<undefined, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ModuleEventData>>

    Returns BridgeModuleResolver

Properties

Protected Readonly bridge

bridge: BridgeModule<BridgeParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.bridge.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    discoverCache?: true | CacheConfig;
    schema: "network.xyo.bridge.config";
}, "schema">, "schema"> & {
    schema: string;
}, "schema">>, ModuleEventData, Module<ModuleParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.module.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<undefined, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ModuleEventData>>

Readonly params

params: BaseParamsFields

Private Optional remoteAddresses

remoteAddresses?: any

Private resolveByAddress

resolveByAddress: any

Private resolveByName

resolveByName: any

Private resolveByQuery

resolveByQuery: any

Private resolveRemoteModules

resolveRemoteModules: any

Private resolveRemoteModulesByAddress

resolveRemoteModulesByAddress: any

Private resolveRemoteModulesByName

resolveRemoteModulesByName: any

Private resolveRemoteModulesByQuery

resolveRemoteModulesByQuery: any

Private resolvedModules

resolvedModules: any

Protected resolvers

resolvers: ModuleResolver[]

Static Optional defaultLogger

defaultLogger?: Logger

Accessors

isModuleResolver

  • get isModuleResolver(): boolean

  • Returns boolean

Protected logger

  • get logger(): Logger | Console

  • Returns Logger | Console

Methods

add

  • Parameters

    • module: Module<ModuleParams<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<undefined, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ModuleEventData>

    Returns BridgeModuleResolver

  • Parameters

    • module: Module<ModuleParams<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<undefined, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ModuleEventData>[]

    Returns BridgeModuleResolver

addResolver

currentResolvedModules

  • Type Parameters

    • T extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<undefined, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>> & EventFunctions<ModuleEventData, T> = Module<ModuleParams<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<undefined, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ModuleEventData>

    Returns Promise<Record<string, T>>

getRemoteAddresses

  • Returns Promise<string[]>

remove

removeResolver

resolve

  • Resolves all modules matching the supplied filter. If no filter is supplied, all modules are returned

    Type Parameters

    • T extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<undefined, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>> & EventFunctions<ModuleEventData, T> = Module<ModuleParams<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<undefined, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ModuleEventData>

    Parameters

    • Optional filter: ModuleFilter

      Filter criteria for the desired modules

    Returns Promise<T[]>

resolveOne

  • Resolves a single module, or undefined if no modules matched the filter.

    Type Parameters

    • T extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<undefined, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>> & EventFunctions<ModuleEventData, T> = Module<ModuleParams<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: "network.xyo.module.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<undefined, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ModuleEventData>

    Parameters

    • filter: string

      The desired Module's Address or Name

    Returns Promise<undefined | T>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc