Class ContainerInitializer

Initializer that sets up a container. Will copy all the files and folders in the given path to the corresponding documents and containers.

Hierarchy

Initializer
- ContainerInitializer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContainerInitializer(args: ContainerInitializerArgs): ContainerInitializer

Overrides Initializer.constructor
- Defined in src/init/ContainerInitializer.ts:50
Parameters
- args: ContainerInitializerArgs
Returns ContainerInitializer

Properties

Private Readonly containerId

containerId: ResourceIdentifier

Private Readonly generator

generator: ResourcesGenerator

Protected Readonly logger

logger: Logger = ...

Private Readonly storage

storage: KeyValueStorage<string, boolean>

Private Readonly storageKey

storageKey: string

Private Readonly store

store: ResourceStore

Methods

canHandle

canHandle(input: void): Promise<void>

Inherited from Initializer.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:13
Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

Parameters
- input: void
  Input that could potentially be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.

handle

handle(): Promise<void>

Overrides Initializer.handle
- Defined in src/init/ContainerInitializer.ts:59
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Returns Promise<void>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: void): Promise<void>

Inherited from Initializer.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:34
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.

Parameters
- input: void
  Input data that will be handled if it can be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.