Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Opener

Helper class that opens components.

IOpenable

Hierarchy

  • Opener

Index

Methods

Static isOpen

  • isOpen(components: any[]): boolean
  • Checks if all components are opened.

    To be checked components must implement IOpenable interface. If they don't the call to this method returns true.

    see

    isOpenOne

    see

    IOpenable

    Parameters

    • components: any[]

      a list of components that are to be checked.

    Returns boolean

    true if all components are opened and false if at least one component is closed.

Static isOpenOne

  • isOpenOne(component: any): boolean
  • Checks if specified component is opened.

    To be checked components must implement IOpenable interface. If they don't the call to this method returns true.

    see

    IOpenable

    Parameters

    • component: any

      the component that is to be checked.

    Returns boolean

    true if component is opened and false otherwise.

Static open

  • open(correlationId: string, components: any[], callback?: function): void
  • Opens multiple components.

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

    see

    openOne

    see

    IOpenable

    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 returns error or null no errors occured.

        • (err: any): void
        • Parameters

          • err: any

          Returns void

    Returns void

Static openOne

  • openOne(correlationId: string, component: any, callback?: function): void
  • Opens specific component.

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

    see

    IOpenable

    Parameters

    • correlationId: string

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

    • component: any

      the component that is to be opened.

    • 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