Interface IUnloadableComponent

Type declaration

• • (unloadCtx?, unloadState?, asyncCallback?): boolean | void

  • Teardown / Unload hook to allow implementations to perform some additional unload operations before the BaseTelemetryPlugin finishes it's removal.

    Parameters

    • Optional unloadCtx: IProcessTelemetryUnloadContext

      This is the context that should be used during unloading.

    • Optional unloadState: ITelemetryUnloadState

      The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.

    • Optional asyncCallback: (() => void)

      An optional callback that the plugin must call if it returns true to inform the caller that it has completed any async unload/teardown operations.

      • • (): void

        • Returns void

    Returns boolean | void

    boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.