Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Closer

Helper class that closes previously opened components.

[[ICloseable]]

Hierarchy

  • Closer

Index

Methods

Methods

Static close

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

  • Closes multiple components.

    To be closed components must implement [[ICloseable]] interface. If they don't the call to this method has no effect.

    see

    closeOne

    see

    IClosable

    Parameters

    • correlationId: string

      (optional) transaction id to trace execution through call chain.

    • components: any[]

      the list of components that are to be closed.

    • Optional callback: function

      callback function that receives error or null no errors occured.

        • (err: any): void

        • Parameters

          • err: any

          Returns void

    Returns void

Static closeOne

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

  • Closes specific component.

    To be closed components must implement [[ICloseable]] interface. If they don't the call to this method has no effect.

    see

    IClosable

    Parameters

    • correlationId: string

      (optional) transaction id to trace execution through call chain.

    • component: any

      the component that is to be closed.

    • Optional callback: function

      callback function that receives error or null no errors occured.

        • (err: any): void

        • Parameters

          • err: any

          Returns void

    Returns void

Generated using TypeDoc