• Adds a disposable resource to a resource-tracking environment object.

    Type Parameters

    • T

    Parameters

    • env: {
          error: unknown;
          hasError: boolean;
          stack: {
              async: boolean;
              dispose?: Function;
              value?: unknown;
          }[];
      }

      A resource-tracking environment object.

      • error: unknown
      • hasError: boolean
      • stack: {
            async: boolean;
            dispose?: Function;
            value?: unknown;
        }[]
    • value: T

      Either a Disposable or AsyncDisposable object, null, or undefined.

    • async: boolean

      When true, AsyncDisposable resources can be added. When false, AsyncDisposable resources cannot be added.

    Returns T

    The value argument.

    Throws

    If value is not an object, or if either Symbol.dispose or Symbol.asyncDispose are not defined, or if value does not have an appropriate Symbol.dispose or Symbol.asyncDispose method.

Generated using TypeDoc