Class StorageArchivistBuilder

Constructors

constructor

Accessors

archivist

Methods

buildArchivist buildConfig findParentArchivist create

Constructors

Protectedconstructor

  • new StorageArchivistBuilder(config, account, node?): StorageArchivistBuilder

  • Parameters

    • config: ArchivistBuilderConfig
    • account: AccountInstance
    • Optionalnode: MemoryNode<BaseParamsFields & {
          account?: AccountInstance | "random";
          addToResolvers?: boolean;
          additionalSigners?: AccountInstance[];
          allowNameResolution?: boolean;
          config: SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & SchemaFields & PayloadFields & {
              archivist?: string;
          } & {
              schema: "network.xyo.node.config";
          }, "schema"> & {
              schema: string;
          };
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
      }, NodeModuleEventData>

    Returns StorageArchivistBuilder

Accessors

archivist

  • get archivist(): StorageArchivist<BaseParamsFields & {
        account?: AccountInstance | "random";
        addToResolvers?: boolean;
        additionalSigners?: AccountInstance[];
        allowNameResolution?: boolean;
        config: SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & {
            parents?: ArchivistParents;
            requireAllParents?: boolean;
            schema: "network.xyo.archivist.storage.config";
            storage?: ArchivistStorage;
            storeParentReads?: boolean;
        } & {
            maxEntries?: number;
            maxEntrySize?: number;
            namespace?: string;
            schema: "network.xyo.archivist.storage.config";
            type?: "page" | "local" | "session";
        }, "schema"> & {
            schema: "network.xyo.archivist.storage.config";
        }, "schema"> & {
            schema: string;
        };
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    }, ArchivistModuleEventData>

  • Returns StorageArchivist<BaseParamsFields & {
        account?: AccountInstance | "random";
        addToResolvers?: boolean;
        additionalSigners?: AccountInstance[];
        allowNameResolution?: boolean;
        config: SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & {
            parents?: ArchivistParents;
            requireAllParents?: boolean;
            schema: "network.xyo.archivist.storage.config";
            storage?: ArchivistStorage;
            storeParentReads?: boolean;
        } & {
            maxEntries?: number;
            maxEntrySize?: number;
            namespace?: string;
            schema: "network.xyo.archivist.storage.config";
            type?: "page" | "local" | "session";
        }, "schema"> & {
            schema: "network.xyo.archivist.storage.config";
        }, "schema"> & {
            schema: string;
        };
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    }, ArchivistModuleEventData>

Methods

buildArchivist

  • buildArchivist(): Promise<StorageArchivist<BaseParamsFields & {
        account?: AccountInstance | "random";
        addToResolvers?: boolean;
        additionalSigners?: AccountInstance[];
        allowNameResolution?: boolean;
        config: SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & {
            parents?: (...) | (...);
            requireAllParents?: (...) | (...) | (...);
            schema: "network.xyo.archivist.storage.config";
            storage?: (...) | (...);
            storeParentReads?: (...) | (...) | (...);
        } & {
            maxEntries?: (...) | (...);
            maxEntrySize?: (...) | (...);
            namespace?: (...) | (...);
            schema: "network.xyo.archivist.storage.config";
            type?:
                | (...)
                | (...)
                | (...)
                | (...);
        }, "schema"> & {
            schema: "network.xyo.archivist.storage.config";
        }, "schema"> & {
            schema: string;
        };
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    }, ArchivistModuleEventData>>

  • Returns Promise<StorageArchivist<BaseParamsFields & {
        account?: AccountInstance | "random";
        addToResolvers?: boolean;
        additionalSigners?: AccountInstance[];
        allowNameResolution?: boolean;
        config: SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & {
            parents?: (...) | (...);
            requireAllParents?: (...) | (...) | (...);
            schema: "network.xyo.archivist.storage.config";
            storage?: (...) | (...);
            storeParentReads?: (...) | (...) | (...);
        } & {
            maxEntries?: (...) | (...);
            maxEntrySize?: (...) | (...);
            namespace?: (...) | (...);
            schema: "network.xyo.archivist.storage.config";
            type?:
                | (...)
                | (...)
                | (...)
                | (...);
        }, "schema"> & {
            schema: "network.xyo.archivist.storage.config";
        }, "schema"> & {
            schema: string;
        };
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    }, ArchivistModuleEventData>>

buildConfig

  • buildConfig(): SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & {
        parents?: ArchivistParents;
        requireAllParents?: boolean;
        schema: "network.xyo.archivist.storage.config";
        storage?: ArchivistStorage;
        storeParentReads?: boolean;
    } & {
        maxEntries?: number;
        maxEntrySize?: number;
        namespace?: string;
        schema: "network.xyo.archivist.storage.config";
        type?: "page" | "local" | "session";
    }, "schema"> & {
        schema: "network.xyo.archivist.storage.config";
    }

  • Returns SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & {
        parents?: ArchivistParents;
        requireAllParents?: boolean;
        schema: "network.xyo.archivist.storage.config";
        storage?: ArchivistStorage;
        storeParentReads?: boolean;
    } & {
        maxEntries?: number;
        maxEntrySize?: number;
        namespace?: string;
        schema: "network.xyo.archivist.storage.config";
        type?: "page" | "local" | "session";
    }, "schema"> & {
        schema: "network.xyo.archivist.storage.config";
    }

findParentArchivist

  • findParentArchivist(): Promise<undefined | ArchivistInstance<BaseParamsFields & {
        account?: AccountInstance | "random";
        addToResolvers?: boolean;
        additionalSigners?: AccountInstance[];
        allowNameResolution?: boolean;
        config: SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & {
            parents?: ...;
            requireAllParents?: ...;
            schema: ...;
            storage?: ...;
            storeParentReads?: ...;
        }, "schema"> & {
            schema: "network.xyo.archivist.config";
        }, "schema"> & {
            schema: string;
        };
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    }, ArchivistModuleEventData, {
        schema: string;
    } & PayloadFields>>

  • Returns Promise<undefined | ArchivistInstance<BaseParamsFields & {
        account?: AccountInstance | "random";
        addToResolvers?: boolean;
        additionalSigners?: AccountInstance[];
        allowNameResolution?: boolean;
        config: SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & {
            parents?: ...;
            requireAllParents?: ...;
            schema: ...;
            storage?: ...;
            storeParentReads?: ...;
        }, "schema"> & {
            schema: "network.xyo.archivist.config";
        }, "schema"> & {
            schema: string;
        };
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    }, ArchivistModuleEventData, {
        schema: string;
    } & PayloadFields>>

Staticcreate

  • create(config, account, node): Promise<StorageArchivistBuilder>

  • Parameters

    • config: ArchivistBuilderConfig
    • account: AccountInstance
    • node: MemoryNode<BaseParamsFields & {
          account?: AccountInstance | "random";
          addToResolvers?: boolean;
          additionalSigners?: AccountInstance[];
          allowNameResolution?: boolean;
          config: SchemaFields & PayloadFields & Omit<ArchivingModuleConfig & ModuleConfigFields & SchemaFields & PayloadFields & {
              archivist?: string;
          } & {
              schema: "network.xyo.node.config";
          }, "schema"> & {
              schema: string;
          };
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
      }, NodeModuleEventData>

    Returns Promise<StorageArchivistBuilder>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods