Class Semaphore

constructor

• new Semaphore(limit, priority?): Semaphore

• Parameters

  • limit: number

  • priority: boolean = false

  Returns Semaphore

Readonly limit

Readonly priority

count

• get count(): number

• Returns number

isLocked

• isLocked(): boolean

• This will be true synchronously upon calling this.lock()().

  Returns boolean

lock

• lock(...params): ResourceAcquireCancellable<Semaphore>

• Parameters

  • Rest ...params: [weight?: number, ctx?: Partial<ContextTimedInput>] | [weight?: number] | [ctx?: Partial<ContextTimedInput>] | []

  Returns ResourceAcquireCancellable<Semaphore>

waitForUnlock

• waitForUnlock(...params): PromiseCancellable<void>

• Parameters

  • Rest ...params: [] | [weight?: number, ctx?: Partial<ContextTimedInput>] | [weight?: number] | [ctx?: Partial<ContextTimedInput>]

  Returns PromiseCancellable<void>

withF

• withF<T>(...params): Promise<T>

• Type Parameters

  • T

  Parameters

  • Rest ...params: [((semaphore) => Promise<T>)] | [undefined | number, undefined | Partial<ContextTimedInput>, ((semaphore) => Promise<T>)] | [undefined | number, ((semaphore) => Promise<T>)] | [undefined | Partial<ContextTimedInput>, ((semaphore) => Promise<T>)]

  Returns Promise<T>

withG

• withG<T, TReturn, TNext>(...params): AsyncGenerator<T, TReturn, TNext>

• Type Parameters

  • T

  • TReturn

  • TNext

  Parameters

  • Rest ...params: [((semaphore) => AsyncGenerator<T, TReturn, TNext>)] | [undefined | number, undefined | Partial<ContextTimedInput>, ((semaphore) => AsyncGenerator<T, TReturn, TNext>)] | [undefined | number, ((semaphore) => AsyncGenerator<T, TReturn, TNext>)] | [undefined | Partial<ContextTimedInput>, ((semaphore) => AsyncGenerator<T, TReturn, TNext>)]

  Returns AsyncGenerator<T, TReturn, TNext>