Class ContextPreconditionAbstract

enabled

Readonlylocation

Readonlyname

Readonlyoptions

Readonlyposition

Readonlystore

container

• get container(): Container

• A reference to the Container object for ease of use.

  Returns Container

  See

  container

error

• error(options?): PreconditionResult

• Constructs a PreconditionError with the precondition parameter set to this.

  Parameters

  • Optionaloptions: Omit<Options, "precondition">

    The information.

  Returns PreconditionResult

ok

• ok(): PreconditionResult

• Returns PreconditionResult

onLoad

• onLoad(): unknown

• Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

  Returns unknown

onUnload

• onUnload(): unknown

• Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.

  Returns unknown

reload

• reload(): Promise<void>

• Reloads the piece by loading the same path in the store.

  Returns Promise<void>

toJSON

• toJSON(): PieceJSON

• Defines the JSON.stringify behavior of this piece.

  Returns PieceJSON

unload

• unload(): Promise<void>

• Unloads and disables the piece.

  Returns Promise<void>