Hierarchy

Implements

Constructors

Properties

eventData: ModuleEventData
defaultLogger?: Logger

Accessors

  • get address(): string
  • Returns string

  • get 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 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>>

  • get config(): 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">
  • Returns 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">

  • get downResolver(): ModuleResolver
  • Returns ModuleResolver

  • get logger(): Logger | Console
  • Returns Logger | Console

  • get queries(): string[]
  • Returns string[]

Methods

  • Parameters

    Returns void

  • Type Parameters

    Parameters

    • eventName: TEventName
    • eventArgs: TEventArgs

    Returns Promise<void>

  • Type Parameters

    Parameters

    • eventName: TEventName
    • eventArgs: TEventArgs

    Returns Promise<void>

  • Parameters

    Returns number

  • Type Parameters

    Parameters

    Returns void

  • Parameters

    Returns void

  • Type Parameters

    Parameters

    Returns (() => void)

      • (): void
      • Returns void

  • Parameters

    Returns (() => void)

      • (): void
      • Returns void

  • Type Parameters

    Parameters

    Returns (() => void)

      • (): void
      • Returns void

  • Type Parameters

    • T extends SchemaFields & PayloadFields & BoundWitnessFields & {
          query: string;
          resultSet?: string;
          schema: "network.xyo.boundwitness";
      } = SchemaFields & PayloadFields & BoundWitnessFields & {
          query: string;
          resultSet?: string;
          schema: "network.xyo.boundwitness";
      }

    Parameters

    • query: T
    • Optional payloads: (SchemaFields & PayloadFields & {
          schema: string;
      })[]

    Returns Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
        schema: string;
    }>>

  • Parameters

    • query: SchemaFields & PayloadFields & BoundWitnessFields & {
          query: string;
          resultSet?: string;
          schema: "network.xyo.boundwitness";
      }
    • Optional payloads: (SchemaFields & PayloadFields & {
          schema: string;
      })[]
    • Optional queryConfig: 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">

    Returns Promise<boolean>

  • Parameters

    Returns Promise<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>[]>

Generated using TypeDoc