Type Alias IReaderSemaphore

Type declaration

• acquireReader:function

  • acquireReader(): Promise<boolean>

  • The acquireReader method acquires an slots only if the slot limit is not reached.

    Returns Promise<boolean>

    Returns true if the slot limit is not reached otherwise false is returned.

• acquireReaderOrFail:function

  • acquireReaderOrFail(): Promise<void>

  • The acquireReaderOrFail method acquires an slots only if the slot limit is not reached. Throws an error if the slot limit is reached.

    Returns Promise<void>

    Throws

• forceReleaseAllReaders:function

  • forceReleaseAllReaders(): Promise<boolean>

  • The forceReleaseAllReaders method releases the all slots.

    Returns Promise<boolean>

    Returns true if the semaphore exists and has at least one unavailable slot or false if all slots are available.

• refreshReader:function

  • refreshReader(ttl?: ITimeSpan): Promise<boolean>

  • The refreshReader method updates the ttl of the slot when acquired.

    Parameters

    • Optionalttl: ITimeSpan

    Returns Promise<boolean>

    Returns true if the slot is refreshed otherwise false is returned.

• refreshReaderOrFail:function

  • refreshReaderOrFail(ttl?: ITimeSpan): Promise<void>

  • The refreshReaderOrFail method updates the ttl of the slot when acquired. Throws an error if the slot is not acquired.

    Parameters

    • Optionalttl: ITimeSpan

    Returns Promise<void>

    Throws

• releaseReader:function

  • releaseReader(): Promise<boolean>

  • The releaseReader method releases the current slot.

    Returns Promise<boolean>

    Returns true if the semaphore exists and has at least one busy slot or false.

• releaseReaderOrFail:function

  • releaseReaderOrFail(): Promise<void>

  • The releaseReaderOrFail method releases the current slot. Throws an error if the slot is not acquired.

    Returns Promise<void>

    Throws

• runReaderOrFail:function

  • runReaderOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): Promise<TValue>

  • The runReaderOrFail method wraps an Invokable with the acquireOrFail and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>

    Returns Promise<TValue>

    Throws