Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Transport

Hierarchy

  • Disposable
    • Transport

Implements

  • DisposableObject

Index

Constructors

Methods

Constructors

constructor

Methods

dispose

  • dispose(): void

isDisposed

  • isDisposed(): boolean

  • Indicates whether the instance is already disposed.

    Returns boolean

on

send

  • send(channel: string, ...args: any[]): void

  • Parameters

    • channel: string
    • Rest ...args: any[]

    Returns void

Static dereference

  • dereference(object: Object, keys?: Property[]): void

  • Dereferences object's keys. If a value of a key implements [[DisposableObject]] interface, [dispose] method of the value will be invoked.

    Parameters

    • object: Object

      Target object.

    • Optional keys: Property[]

      Keys to dereference. Optional. By default all keys will be dereferenced.

    Returns void

Static dispose

  • dispose(object: DisposableObject | Object, deref?: undefined | false | true): void

  • Tries to dispose a given object if it implements [[DisposableObject]] interface. If the object does not implement the interface, but [deref] param is passed, the method will try to dereference all object's keys.

    Parameters

    • object: DisposableObject | Object

      Target object to dispose.

    • Optional deref: undefined | false | true

      A value indicating whether to perform dereferncing.

    Returns void

Static isDisposable

  • isDisposable(object?: any): boolean

  • Indicates if a given object implements [[DisposableObject]] interface.

    Parameters

    • Optional object: any

      Target object.

    Returns boolean

Generated using TypeDoc