Class Cleaner

Helper class that cleans stored object state.

see: ICleanable

Hierarchy

Cleaner

Index

Methods

Methods

Static clear

clear(correlationId: string, components: any[], callback?: function): void

- Defined in run/Cleaner.ts:50
Clears state of multiple components.

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

see

clearOne

see

ICleanable

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- components: any[]
  
  the list of components that are to be cleaned.
- Optional callback: function
  
  callback function that returns error or null no errors occured.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

Static clearOne

clearOne(correlationId: string, component: any, callback?: function): void

- Defined in run/Cleaner.ts:25
Clears state of specific component.

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

see

ICleanable

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- component: any
  
  the component that is to be cleaned.
- Optional callback: function
  
  callback function that returns error or null no errors occured.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

Generated using TypeDoc