Cleaner

Helper class that allows you to clear the state of components.

Description

The Cleaner class allows you to clear the state of components.

Static methods

clear

Clears state of multiple components.

To be cleaned, state components must implement the ICleanable interface. If they don’t, the call to this method has no effect.

public static clear(context: IContext, components: any[]): Promise<void>

  • context: IContext - (optional) execution context to trace execution through call chain.
  • components: any[] - list of components that are to be cleaned.

clearOne

Clears the state of a specific component. To be cleaned, state components must implement ICleanable interface. If they don’t, the call to this method has no effect.

public static clearOne(context: IContext, component: any): Promise<void>

  • context: IContext - (optional) execution context to trace execution through call chain.
  • component: any - component that is to be cleaned.

See also