Function timedSupply

  • Creates supply, that is automatically cut off after specified timeout.

    Type Parameters

    • TResult = void

      Supply result type.

    Parameters

    • timeout: number

      The maximum time in milliseconds the supply exists for.

    • __namedParameters: {
          onTimeout?: ((this, timeout) => SupplyIsOff<TResult>);
          supply?: Supply<TResult>;
      } = {}
      • Optional Readonly onTimeout?: ((this, timeout) => SupplyIsOff<TResult>)
      • Optional Readonly supply?: Supply<TResult>

    Returns Supply<TResult>

    Timed supply instance. The timer will be stopped once this supply cut off.

Generated using TypeDoc