Interface BuilderFactory

Functions that permit the creation of Builder objects.

interface BuilderFactory {
    fromArchive: (archive: Blob) => Promise<Builder>;
    fromDefinition: (definition: ManifestDefinition) => Promise<Builder>;
    new: () => Promise<Builder>;
}

Index

Properties

fromArchive fromDefinition new

Properties

fromArchive

fromArchive: (archive: Blob) => Promise<Builder>

Create a Builder from a builder archive (created from Builder.toArchive).

Type Declaration

- (archive: Blob): Promise<Builder>
- Parameters
  - archive: Blob
    Builder archive as a blob.
  Returns Promise<Builder>
  A Builder object.

fromDefinition

fromDefinition: (definition: ManifestDefinition) => Promise<Builder>

Create a Builder from a ManifestDefinition.

Type Declaration

- (definition: ManifestDefinition): Promise<Builder>
- Parameters
  - definition: ManifestDefinition
    The ManifestDefinition to be used as the builder's initial state.
  Returns Promise<Builder>
  A Builder object.

new

new: () => Promise<Builder>

Create a Builder with a minimal manifest definition as its initial state.

Type Declaration

- (): Promise<Builder>
- Returns Promise<Builder>
  A Builder object.