Class MemorySchemaListDiviner<TParams>

Type Parameters

Hierarchy

Constructors

constructor

Properties

_baseModuleQueryAccountPaths _queryAccounts _started account commitArchivist downResolver eventData moduleConfigQueryValidator params readArchivist supportedQueryValidator upResolver writeArchivist configSchema defaultLogger? targetSchema

Accessors

_queryAccountPaths address allowAnonymous config logger queries queryAccountPaths queryAccounts

Methods

bindHashes bindHashesInternal bindQuery bindQueryInternal bindQueryResult clearListeners discover divine divineAddress divineAllAddresses emit emitSerial initializeQueryAccounts listenerCount loadAccount moduleAccountQuery off offAny on onAny once query queryHandler queryable resolve start started stop subscribe validateConfig create factory

Constructors

constructor

Properties

Protected Readonly _baseModuleQueryAccountPaths

_baseModuleQueryAccountPaths: Record<"network.xyo.query.module.discover" | "network.xyo.query.module.account" | "network.xyo.query.module.subscribe", string>

Protected Readonly _queryAccounts

_queryAccounts: Record<"network.xyo.query.module.discover" | "network.xyo.query.module.account" | "network.xyo.query.module.subscribe", undefined | AccountInstance>

Protected _started

_started: boolean

Protected Readonly account

account: AccountInstance

Protected commitArchivist

commitArchivist: (() => Promise<undefined | ArchivistModule<ArchivistParams<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.archivist.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    parents?: ArchivistParents;
    schema: "network.xyo.archivist.config";
    storeParentReads?: boolean;
} & Omit<undefined, "schema">, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ArchivistModuleEventData>>)

Type declaration

    • (): Promise<undefined | ArchivistModule<ArchivistParams<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.archivist.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<{
          parents?: ArchivistParents;
          schema: "network.xyo.archivist.config";
          storeParentReads?: boolean;
      } & Omit<undefined, "schema">, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ArchivistModuleEventData>>

    • Returns Promise<undefined | ArchivistModule<ArchivistParams<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.archivist.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<{
          parents?: ArchivistParents;
          schema: "network.xyo.archivist.config";
          storeParentReads?: boolean;
      } & Omit<undefined, "schema">, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ArchivistModuleEventData>>

Readonly downResolver

downResolver: CompositeModuleResolver

eventData

eventData: DivinerModuleEventData

Protected Readonly moduleConfigQueryValidator

moduleConfigQueryValidator: Queryable<SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}>

Readonly params

params: TParams

Protected readArchivist

readArchivist: (() => Promise<undefined | ArchivistModule<ArchivistParams<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.archivist.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    parents?: ArchivistParents;
    schema: "network.xyo.archivist.config";
    storeParentReads?: boolean;
} & Omit<undefined, "schema">, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ArchivistModuleEventData>>)

Type declaration

    • (): Promise<undefined | ArchivistModule<ArchivistParams<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.archivist.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<{
          parents?: ArchivistParents;
          schema: "network.xyo.archivist.config";
          storeParentReads?: boolean;
      } & Omit<undefined, "schema">, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ArchivistModuleEventData>>

    • Returns Promise<undefined | ArchivistModule<ArchivistParams<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.archivist.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<{
          parents?: ArchivistParents;
          schema: "network.xyo.archivist.config";
          storeParentReads?: boolean;
      } & Omit<undefined, "schema">, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ArchivistModuleEventData>>

Protected Readonly supportedQueryValidator

supportedQueryValidator: Queryable<SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}>

Readonly upResolver

upResolver: CompositeModuleResolver

Protected writeArchivist

writeArchivist: (() => Promise<undefined | ArchivistModule<ArchivistParams<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.archivist.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    parents?: ArchivistParents;
    schema: "network.xyo.archivist.config";
    storeParentReads?: boolean;
} & Omit<undefined, "schema">, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ArchivistModuleEventData>>)

Type declaration

    • (): Promise<undefined | ArchivistModule<ArchivistParams<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.archivist.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<{
          parents?: ArchivistParents;
          schema: "network.xyo.archivist.config";
          storeParentReads?: boolean;
      } & Omit<undefined, "schema">, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ArchivistModuleEventData>>

    • Returns Promise<undefined | ArchivistModule<ArchivistParams<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.archivist.config";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<{
          parents?: ArchivistParents;
          schema: "network.xyo.archivist.config";
          storeParentReads?: boolean;
      } & Omit<undefined, "schema">, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, ArchivistModuleEventData>>

Static configSchema

configSchema: "network.xyo.diviner.schema.list.config"

Static Optional defaultLogger

defaultLogger?: Logger

Static targetSchema

targetSchema: string

Accessors

Protected _queryAccountPaths

  • get _queryAccountPaths(): Record<"network.xyo.query.diviner.divine", string>

  • Returns Record<"network.xyo.query.diviner.divine", string>

address

  • get address(): string

  • Returns string

allowAnonymous

  • get allowAnonymous(): boolean

  • Returns boolean

config

  • get config(): TParams["config"]

  • Returns TParams["config"]

Protected logger

  • get logger(): Logger | Console

  • Returns Logger | Console

queries

  • get queries(): string[]

  • Returns string[]

queryAccountPaths

  • get queryAccountPaths(): Readonly<Record<string, undefined | string>>

  • Returns Readonly<Record<string, undefined | string>>

queryAccounts

  • get queryAccounts(): Readonly<Record<string, undefined | AccountInstance>>

  • Returns Readonly<Record<string, undefined | AccountInstance>>

Methods

Protected bindHashes

  • Parameters

    • hashes: string[]
    • schema: string[]
    • Optional account: AccountInstance

    Returns PromiseEx<unknown, AccountInstance>

Protected bindHashesInternal

  • Parameters

    • hashes: string[]
    • schema: string[]
    • Optional account: AccountInstance

    Returns Promise<SchemaFields & PayloadFields & BoundWitnessFields & {
        schema: "network.xyo.boundwitness";
    }>

Protected bindQuery

  • Type Parameters

    • T extends SchemaFields & PayloadFields & QueryFields & {
          schema: string;
      } | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
          schema: string;
      }>

    Parameters

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

    Returns PromiseEx<[SchemaFields & PayloadFields & BoundWitnessFields & {
        query: string;
        resultSet?: string;
        schema: "network.xyo.boundwitness";
    }, (SchemaFields & PayloadFields & {
        schema: string;
    })[]], AccountInstance>

Protected bindQueryInternal

  • Type Parameters

    • T extends SchemaFields & PayloadFields & QueryFields & {
          schema: string;
      } | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
          schema: string;
      }>

    Parameters

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

    Returns Promise<[SchemaFields & PayloadFields & BoundWitnessFields & {
        query: string;
        resultSet?: string;
        schema: "network.xyo.boundwitness";
    }, (SchemaFields & PayloadFields & {
        schema: string;
    })[]]>

Protected bindQueryResult

  • Type Parameters

    • T extends SchemaFields & PayloadFields & QueryFields & {
          schema: string;
      } | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
          schema: string;
      }>

    Parameters

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

    Returns PromiseEx<ModuleQueryResult<SchemaFields & PayloadFields & {
        schema: string;
    }>, AccountInstance[]>

clearListeners

  • Parameters

    • eventNames: keyof DivinerModuleEventData | (keyof DivinerModuleEventData)[]

    Returns void

discover

  • Returns Promisable<(SchemaFields & PayloadFields & {
        schema: string;
    })[], never>

divine

  • Parameters

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

    Returns Promise<(SchemaFields & PayloadFields & {
        schema: string;
    })[]>

Protected divineAddress

  • Parameters

    • address: string

    Returns Promise<string[]>

Protected divineAllAddresses

  • Returns Promise<string[]>

emit

  • Type Parameters

    • TEventName extends keyof DivinerModuleEventData = keyof DivinerModuleEventData

    • TEventArgs extends EventArgs = DivinerModuleEventData[TEventName]

    Parameters

    • eventName: TEventName
    • eventArgs: TEventArgs

    Returns Promise<void>

emitSerial

  • Type Parameters

    • TEventName extends keyof DivinerModuleEventData = keyof DivinerModuleEventData

    • TEventArgs extends EventArgs = DivinerModuleEventData[TEventName]

    Parameters

    • eventName: TEventName
    • eventArgs: TEventArgs

    Returns Promise<void>

Protected initializeQueryAccounts

listenerCount

  • Parameters

    • eventNames: keyof DivinerModuleEventData | (keyof DivinerModuleEventData)[]

    Returns number

Protected loadAccount

  • Parameters

    • Optional account: AccountInstance

    Returns AccountInstance

moduleAccountQuery

  • Returns Promisable<(SchemaFields & PayloadFields & {
        address: string;
        name?: string;
        schema: "network.xyo.address";
    } | SchemaFields & PayloadFields & {
        address: string;
        previousHash?: string;
        schema: string;
    })[], never>

off

  • Type Parameters

    • TEventName extends keyof DivinerModuleEventData

    Parameters

    • eventNames: TEventName | TEventName[]
    • listener: EventListener<DivinerModuleEventData[TEventName]>

    Returns void

offAny

  • Parameters

    • listener: EventAnyListener<EventArgs>

    Returns void

on

  • Type Parameters

    • TEventName extends keyof DivinerModuleEventData

    Parameters

    • eventNames: TEventName | TEventName[]
    • listener: EventListener<DivinerModuleEventData[TEventName]>

    Returns (() => void)

      • (): void

      • Returns void

onAny

  • Parameters

    • listener: EventAnyListener<EventArgs>

    Returns (() => void)

      • (): void

      • Returns void

once

  • Type Parameters

    • TEventName extends keyof DivinerModuleEventData

    Parameters

    • eventName: TEventName
    • listener: EventListener<DivinerModuleEventData[TEventName]>

    Returns (() => void)

      • (): void

      • Returns void

query

  • 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";
      }

    • TConfig extends 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"> = 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">

    Parameters

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

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

Protected queryHandler

  • 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";
      }

    • TConfig extends 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"> = 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">

    Parameters

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

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

queryable

  • 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";
      }

    • TConfig extends 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"> = 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">

    Parameters

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

    Returns boolean

Protected resolve

  • Type Parameters

    • TModule 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, TModule> = 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

    Returns Promise<TModule[]>

start

  • Parameters

    • Optional _timeout: number

    Returns Promisable<void, never>

started

  • Parameters

    • Optional notStartedAction: "error" | "throw" | "warn" | "log" | "none"

    Returns boolean

Protected stop

subscribe

  • Parameters

    • Optional _queryAccount: AccountInstance

    Returns void

Protected validateConfig

  • Parameters

    • Optional config: unknown
    • Optional parents: string[]

    Returns boolean

Static create

  • Type Parameters

    • TModule 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, TModule>

    Parameters

    • this: CreatableModule<TModule>
    • Optional params: TModule["params"]

    Returns Promise<TModule>

Static factory

  • Type Parameters

    • TModule 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, TModule>

    Parameters

    • this: CreatableModule<TModule>
    • Optional params: TModule["params"]

    Returns CreatableModuleFactory<TModule>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc