Class ModuleFactory<TModule>

constructor

• new ModuleFactory<TModule>(creatableModule, params?): ModuleFactory<TModule>

• 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

  • creatableModule: CreatableModule<TModule>

  • Optional params: TModule["params"]

  Returns ModuleFactory<TModule>

configSchema

creatableModule

Optional defaultLogger

Optional defaultParams

create

• create<T>(this, params?): Promise<T>

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

  Parameters

  • this: CreatableModuleFactory<T>

  • Optional params: TModule["params"]

  Returns Promise<T>

factory

• factory<T>(this, _params?): CreatableModuleFactory<T>

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

  Parameters

  • this: CreatableModule<T>

  • Optional _params: T["params"]

  Returns CreatableModuleFactory<T>

Static withParams

• withParams<T>(creatableModule, params?): ModuleFactory<T>

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

  Parameters

  • creatableModule: CreatableModule<T>

  • Optional params: T["params"]

  Returns ModuleFactory<T>