XYO Platform SDK - v3.10.6
    Preparing search index...

    Type Alias ConstructableModuleWrapper<TWrapper>

    type ConstructableModuleWrapper<TWrapper extends ModuleWrapper> = {
        defaultLogger?: Logger;
        instanceIdentityCheck: InstanceTypeCheck;
        moduleIdentityCheck: ModuleTypeCheck;
        requiredQueries: string[];
        canWrap(
            mod:
                | undefined
                | Module<
                    BaseParamsFields & {
                        account?: AccountInstance
                        | "random";
                        additionalSigners?: AccountInstance[];
                        addToResolvers?: boolean;
                        allowNameResolution?: boolean;
                        config: TConfig extends AnyConfigSchema<ModuleConfig>
                            ? TConfig
                            : AnyConfigSchema<ModuleConfig>;
                        ephemeralQueryAccountEnabled?: boolean;
                        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                        privateChildren?: ModuleInstance[];
                        publicChildren?: ModuleInstance[];
                    },
                    ModuleEventData<object>,
                >,
        ): boolean;
        is<
            TModuleWrapper extends
                ModuleWrapper<
                    Module<
                        BaseParamsFields & {
                            account?: AccountInstance
                            | "random";
                            additionalSigners?: AccountInstance[];
                            addToResolvers?: boolean;
                            allowNameResolution?: boolean;
                            config: TConfig extends AnyConfigSchema<ModuleConfig>
                                ? TConfig
                                : AnyConfigSchema<ModuleConfig>;
                            ephemeralQueryAccountEnabled?: boolean;
                            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                            privateChildren?: ModuleInstance[];
                            publicChildren?: ModuleInstance[];
                        },
                        ModuleEventData<object>,
                    >,
                >,
        >(
            this: ConstructableModuleWrapper<TModuleWrapper>,
            wrapper?: any,
        ): wrapper is TModuleWrapper;
        tryWrap<
            TModuleWrapper extends
                ModuleWrapper<
                    Module<
                        BaseParamsFields & {
                            account?: AccountInstance
                            | "random";
                            additionalSigners?: AccountInstance[];
                            addToResolvers?: boolean;
                            allowNameResolution?: boolean;
                            config: TConfig extends AnyConfigSchema<ModuleConfig>
                                ? TConfig
                                : AnyConfigSchema<ModuleConfig>;
                            ephemeralQueryAccountEnabled?: boolean;
                            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                            privateChildren?: ModuleInstance[];
                            publicChildren?: ModuleInstance[];
                        },
                        ModuleEventData<object>,
                    >,
                >,
        >(
            this: ConstructableModuleWrapper<TModuleWrapper>,
            mod:
                | undefined
                | Module<
                    BaseParamsFields & {
                        account?: AccountInstance
                        | "random";
                        additionalSigners?: AccountInstance[];
                        addToResolvers?: boolean;
                        allowNameResolution?: boolean;
                        config: TConfig extends AnyConfigSchema<ModuleConfig>
                            ? TConfig
                            : AnyConfigSchema<ModuleConfig>;
                        ephemeralQueryAccountEnabled?: boolean;
                        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                        privateChildren?: ModuleInstance[];
                        publicChildren?: ModuleInstance[];
                    },
                    ModuleEventData<object>,
                >,
            account: AccountInstance,
            checkIdentity?: boolean,
        ): undefined | TModuleWrapper;
        wrap<
            TModuleWrapper extends
                ModuleWrapper<
                    Module<
                        BaseParamsFields & {
                            account?: AccountInstance
                            | "random";
                            additionalSigners?: AccountInstance[];
                            addToResolvers?: boolean;
                            allowNameResolution?: boolean;
                            config: TConfig extends AnyConfigSchema<ModuleConfig>
                                ? TConfig
                                : AnyConfigSchema<ModuleConfig>;
                            ephemeralQueryAccountEnabled?: boolean;
                            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                            privateChildren?: ModuleInstance[];
                            publicChildren?: ModuleInstance[];
                        },
                        ModuleEventData<object>,
                    >,
                >,
        >(
            this: ConstructableModuleWrapper<TModuleWrapper>,
            mod:
                | undefined
                | Module<
                    BaseParamsFields & {
                        account?: AccountInstance
                        | "random";
                        additionalSigners?: AccountInstance[];
                        addToResolvers?: boolean;
                        allowNameResolution?: boolean;
                        config: TConfig extends AnyConfigSchema<ModuleConfig>
                            ? TConfig
                            : AnyConfigSchema<ModuleConfig>;
                        ephemeralQueryAccountEnabled?: boolean;
                        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                        privateChildren?: ModuleInstance[];
                        publicChildren?: ModuleInstance[];
                    },
                    ModuleEventData<object>,
                >,
            account: AccountInstance,
            checkIdentity?: boolean,
        ): TModuleWrapper;
        new (params: ModuleWrapperParams<TWrapper["mod"]>): TWrapper;
    }

    Type Parameters

    Index

    Properties

    defaultLogger? instanceIdentityCheck moduleIdentityCheck requiredQueries

    Methods

    canWrap is tryWrap wrap

    Properties

    defaultLogger?: Logger
    instanceIdentityCheck: InstanceTypeCheck
    moduleIdentityCheck: ModuleTypeCheck
    requiredQueries: string[]

    Methods

    • Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods