Class StreamPool

Hierarchy

EventEmitter
- StreamPool

Index

Constructors

constructor

Accessors

entries

Methods

Constructors

constructor

new StreamPool(options?: MasterchatOptions): StreamPool

- Defined in src/pool.ts:47
Parameters
- Optional options: MasterchatOptions
Returns StreamPool

Accessors

entries

get entries(): [string, Masterchat][]

- Defined in src/pool.ts:52
Returns [string, Masterchat][]

Methods

addListener

addListener<U>(event: U, listener: StreamPoolEvents[U]): StreamPool

- Defined in src/pool.ts:24
Type Parameters
- U extends keyof StreamPoolEvents
Parameters
- event: U
- listener: StreamPoolEvents[U]
Returns StreamPool

emit

emit<U>(event: U, ...args: Parameters<StreamPoolEvents[U]>): boolean

- Defined in src/pool.ts:36
Type Parameters
- U extends keyof StreamPoolEvents
Parameters
- event: U
- Rest ...args: Parameters<StreamPoolEvents[U]>
Returns boolean

ensure

ensure(): Promise<void>

- Defined in src/pool.ts:79
resolves after every stream closed

Returns Promise<void>

forEach

forEach(fn: ((agent: Masterchat, videoId: string, index: number) => void)): Promise<PromiseSettledResult<void>[]>

- Defined in src/pool.ts:56
Parameters
- fn: ((agent: Masterchat, videoId: string, index: number) => void)
  - - (agent: Masterchat, videoId: string, index: number): void
    - Parameters
      - agent: Masterchat
      - videoId: string
      - index: number
      Returns void
Returns Promise<PromiseSettledResult<void>[]>

get

get(videoId: string): undefined | Masterchat

- Defined in src/pool.ts:72
Parameters
- videoId: string
Returns undefined | Masterchat

has

has(videoId: string): boolean

- Defined in src/pool.ts:100
check if the given stream is already subscribed

Parameters
- videoId: string
Returns boolean

off

off<U>(event: U, listener: StreamPoolEvents[U]): StreamPool

- Defined in src/pool.ts:28
Type Parameters
- U extends keyof StreamPoolEvents
Parameters
- event: U
- listener: StreamPoolEvents[U]
Returns StreamPool

on

on<U>(event: U, listener: StreamPoolEvents[U]): StreamPool

- Defined in src/pool.ts:20
Type Parameters
- U extends keyof StreamPoolEvents
Parameters
- event: U
- listener: StreamPoolEvents[U]
Returns StreamPool

removeListener

removeListener<U>(event: U, listener: StreamPoolEvents[U]): StreamPool

- Defined in src/pool.ts:32
Type Parameters
- U extends keyof StreamPoolEvents
Parameters
- event: U
- listener: StreamPoolEvents[U]
Returns StreamPool

setCredentials

setCredentials(credentials?: string | Credentials): void

- Defined in src/pool.ts:66
Parameters
- Optional credentials: string | Credentials
Returns void

streamCount

streamCount(): number

- Defined in src/pool.ts:93
number of active streams

Returns number

subscribe

subscribe(videoId: string, channelId: string, iterateOptions?: IterateChatOptions): Masterchat

- Defined in src/pool.ts:108
subscribe live chat. always guarantees single instance for each stream.

Parameters
- videoId: string
- channelId: string
- Optional iterateOptions: IterateChatOptions
Returns Masterchat

unsubscribe

unsubscribe(videoId: string): void

- Defined in src/pool.ts:143
stop subscribing live chat

Parameters
- videoId: string
Returns void

Generated using TypeDoc