Class Semaphore

Hierarchy

EventEmitter
- Semaphore
  - RateLimiter
  - Mutex

Index

Constructors

constructor

new Semaphore(space: number): Semaphore
Parameters
- space: number
Returns Semaphore
Overrides EventEmitter.constructor
- Defined in src/semaphore.ts:21

Properties

`Protected` _releases

_releases: Release[]

`Protected` _space

_space: number

`Protected` _used

_used: number

`Static` prefixed

prefixed: string | boolean

Accessors

space

get space(): number
Returns number
- Defined in src/semaphore.ts:9

used

get used(): number
Returns number
- Defined in src/semaphore.ts:13

waiting

get waiting(): number
Returns number
- Defined in src/semaphore.ts:17

Methods

addListener

addListener<T>(event: T, fn: ((...args: any[]) => void), context?: any): Semaphore
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
Returns Semaphore
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:45

down

down(): number
Returns number
- Defined in src/semaphore.ts:49

emit

emit(event: "up" | "down" | "all-clear"): boolean
Parameters
- event: "up" | "down" | "all-clear"
Returns boolean
Overrides EventEmitter.emit
- Defined in src/semaphore.ts:85
emit(event: "wait", data: {
release: Release;
}): boolean
Parameters
- event: "wait"
- data: {
  release: Release;
  }
  - release: Release
Returns boolean
Overrides EventEmitter.emit
- Defined in src/semaphore.ts:86
emit(event: string, ...args: any[]): boolean
Parameters
- event: string
- Rest ...args: any[]
Returns boolean
Overrides EventEmitter.emit
- Defined in src/semaphore.ts:87

empty

empty(): boolean
Returns boolean
- Defined in src/semaphore.ts:81

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:15

full

full(): boolean
Returns boolean
- Defined in src/semaphore.ts:77

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:20

off

off(event: "up" | "down" | "all-clear", listener: (() => void)): Semaphore
Parameters
- event: "up" | "down" | "all-clear"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Semaphore
Overrides EventEmitter.off
- Defined in src/semaphore.ts:99
off(event: "wait", listener: ((data: {
release: Release;
}) => void)): Semaphore
Parameters
- event: "wait"
- listener: ((data: {
  release: Release;
  }) => void)
  - - (data: {
      release: Release;
      }): void
    - Parameters
      
      data: {
      release: Release;
      }
      
      release: Release
      
      Returns void
Returns Semaphore
Overrides EventEmitter.off
- Defined in src/semaphore.ts:100
off(event: string, listener: ((...args: any[]) => void)): Semaphore
Parameters
- event: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Semaphore
Overrides EventEmitter.off
- Defined in src/semaphore.ts:101

on

on(event: "up" | "down" | "all-clear", listener: (() => void)): Semaphore
Parameters
- event: "up" | "down" | "all-clear"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Semaphore
Overrides EventEmitter.on
- Defined in src/semaphore.ts:92
on(event: "wait", listener: ((data: {
release: Release;
}) => void)): Semaphore
Parameters
- event: "wait"
- listener: ((data: {
  release: Release;
  }) => void)
  - - (data: {
      release: Release;
      }): void
    - Parameters
      
      data: {
      release: Release;
      }
      
      release: Release
      
      Returns void
Returns Semaphore
Overrides EventEmitter.on
- Defined in src/semaphore.ts:93
on(event: string, listener: ((...args: any[]) => void)): Semaphore
Parameters
- event: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Semaphore
Overrides EventEmitter.on
- Defined in src/semaphore.ts:94

once

once(event: "up" | "down" | "all-clear", listener: (() => void)): Semaphore
Parameters
- event: "up" | "down" | "all-clear"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Semaphore
Overrides EventEmitter.once
- Defined in src/semaphore.ts:106
once(event: "wait", listener: ((data: {
release: Release;
}) => void)): Semaphore
Parameters
- event: "wait"
- listener: ((data: {
  release: Release;
  }) => void)
  - - (data: {
      release: Release;
      }): void
    - Parameters
      
      data: {
      release: Release;
      }
      
      release: Release
      
      Returns void
Returns Semaphore
Overrides EventEmitter.once
- Defined in src/semaphore.ts:107
once(event: string, listener: ((...args: any[]) => void)): Semaphore
Parameters
- event: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Semaphore
Overrides EventEmitter.once
- Defined in src/semaphore.ts:108

removeAllListeners

removeAllListeners(event?: string | symbol): Semaphore
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string | symbol
Returns Semaphore
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: any[]) => void), context?: any, once?: boolean): Semaphore
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns Semaphore
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:63

resize

resize(space: number): Semaphore
Parameters
- space: number
Returns Semaphore
- Defined in src/semaphore.ts:67

up

up(): Promise<number>
Returns Promise<number>
- Defined in src/semaphore.ts:28

Class Semaphore

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

space: number

Returns Semaphore

Properties

Protected _releases

Protected _space

Protected _used

Static prefixed

Accessors

space

Returns number

used

Returns number

waiting

Returns number

Methods

addListener

Type Parameters

T extends string | symbol

Parameters

event: T

fn: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns Semaphore

down

Returns number

emit

Parameters

event: "up" | "down" | "all-clear"

Returns boolean

Parameters

event: "wait"

data: { release: Release; }

release: Release

Returns boolean

Parameters

event: string

Rest ...args: any[]

Returns boolean

empty

Returns boolean

eventNames

Returns (string | symbol)[]

full

Returns boolean

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Type Parameters

T extends string | symbol

Parameters

event: T

Returns ((...args: any[]) => void)[]

off

Parameters

event: "up" | "down" | "all-clear"

listener: (() => void)

Returns void

Returns Semaphore

Parameters

event: "wait"

listener: ((data: { release: Release; }) => void)

Parameters

data: { release: Release; }

release: Release

Returns void

`Protected` _releases

`Protected` _space

`Protected` _used

`Static` prefixed

`Rest` ...args: any[]

`Optional` context: any

data: {
release: Release;
}

`Rest` ...args: any[]

listener: ((data: {
release: Release;
}) => void)

data: {
release: Release;
}

`Rest` ...args: any[]

listener: ((data: {
release: Release;
}) => void)

data: {
release: Release;
}

`Rest` ...args: any[]

listener: ((data: {
release: Release;
}) => void)

data: {
release: Release;
}

`Rest` ...args: any[]

`Optional` event: string | symbol

`Optional` fn: ((...args: any[]) => void)

`Rest` ...args: any[]

`Optional` context: any

`Optional` once: boolean