Class Stream

Hierarchy

Twitch
- Stream

Index

Constructors

constructor

new Stream(clientId, clientSecret, timerMinutes?): Stream
Parameters
- clientId: string
- clientSecret: string
- Optional timerMinutes: number
Returns Stream
Overrides Twitch.constructor
- Defined in stream.ts:22

Properties

`Private` #announce

#announce: Announcements

`Private` #announcements

#announcements: Map<string, AnnounceData> = ...

`Private` #cache

#cache: Map<string, LiveStream> = ...

`Private` #clientId

#clientId: string

`Private` #clientSecret

#clientSecret: string

`Private` #data

#data: string[]

`Private` #debug

#debug: boolean

`Private` #stream

#stream: EventEmitter = ...

`Private` #timer

#timer: number = ...

Note

In ms.

`Private` #toggles

#toggles: {
    ended: boolean;
    live: boolean;
    update: boolean;
} = ...

Type declaration

ended: boolean
live: boolean
update: boolean

bearer

bearer: Bearer

Accessors

announcements

get announcements(): {
    add: ((user, webhooks) => Stream);
    list: ((user?) => {
        user: string;
        webhooks: string[];
    }[]);
    remove: ((user, webhooks?) => Stream);
}
Returns {
    add: ((user, webhooks) => Stream);
    list: ((user?) => {
        user: string;
        webhooks: string[];
    }[]);
    remove: ((user, webhooks?) => Stream);
}
- add: ((user, webhooks) => Stream)
  - - (user, webhooks): Stream
    - Parameters
      
      user: string
      
      webhooks: string[]
      Returns Stream
- list: ((user?) => {
  user: string;
  webhooks: string[];
  }[])
  - - (user?): {
      user: string;
      webhooks: string[];
      }[]
    - Parameters
      
      Optional user: string
      Returns {
      user: string;
      webhooks: string[];
      }[]
- remove: ((user, webhooks?) => Stream)
  - - (user, webhooks?): Stream
    - Parameters
      
      user: string
      
      Optional webhooks: string[]
      Returns Stream
- Defined in stream.ts:43

caches

get caches(): {
    add: ((stream) => void);
    all: (() => LiveStream[]);
    delete: ((id) => boolean);
    get: ((id) => undefined | LiveStream);
    size: (() => number);
    update: ((stream) => Map<string, LiveStream>);
    user: ((user) => undefined | LiveStream);
}
Returns {
    add: ((stream) => void);
    all: (() => LiveStream[]);
    delete: ((id) => boolean);
    get: ((id) => undefined | LiveStream);
    size: (() => number);
    update: ((stream) => Map<string, LiveStream>);
    user: ((user) => undefined | LiveStream);
}
- add: ((stream) => void)
  - - (stream): void
    - Parameters
      
      stream: LiveStream
      Returns void
- all: (() => LiveStream[])
  - - (): LiveStream[]
    - Returns LiveStream[]
- delete: ((id) => boolean)
  - - (id): boolean
    - Parameters
      
      id: string
      Returns boolean
- get: ((id) => undefined | LiveStream)
  - - (id): undefined | LiveStream
    - Parameters
      
      id: string
      Returns undefined | LiveStream
- size: (() => number)
  - - (): number
    - Returns number
- update: ((stream) => Map<string, LiveStream>)
  - - (stream): Map<string, LiveStream>
    - Parameters
      
      stream: LiveStream
      Returns Map<string, LiveStream>
- user: ((user) => undefined | LiveStream)
  - - (user): undefined | LiveStream
    - Parameters
      
      user: string
      Returns undefined | LiveStream
- Defined in stream.ts:102

toggles

get toggles(): {
    ended: boolean;
    live: boolean;
    update: boolean;
}
Returns {
    ended: boolean;
    live: boolean;
    update: boolean;
}
- ended: boolean
- live: boolean
- update: boolean
- Defined in stream.ts:39

users

get users(): {
    add: ((users) => Stream);
    list: (() => string[]);
    remove: ((users) => Stream);
}
Returns {
    add: ((users) => Stream);
    list: (() => string[]);
    remove: ((users) => Stream);
}
- add: ((users) => Stream)
  - - (users): Stream
    - Parameters
      
      users: Data
      Returns Stream
- list: (() => string[])
  - - (): string[]
    - Returns string[]
- remove: ((users) => Stream)
  - - (users): Stream
    - Parameters
      
      users: Data
      Returns Stream
- Defined in stream.ts:138

Methods

`Private` #checkIfLive

#checkIfLive(user): Promise<boolean>
Parameters
- user: string
Returns Promise<boolean>
Inherited from Twitch.#checkIfLive
- Defined in index.ts:270

`Private` #fetch

#fetch<D>(url, method?): FetchResults<D>
Type Parameters
- D extends object
Parameters
- url: string
- method: RequestMethod = "GET"
Returns FetchResults<D>
Inherited from Twitch.#fetch
- Defined in index.ts:224

`Private` #generateToken

#generateToken(): Promise<null | string>
Returns Promise<null | string>
Inherited from Twitch.#generateToken
- Defined in index.ts:200

`Private` #getURL

#getURL(endpoint, users, isStream?): GetUrlResults
Parameters
- endpoint: string
- users: Data
- isStream: boolean = true
Returns GetUrlResults
Inherited from Twitch.#getURL
- Defined in index.ts:62

`Private` #log

#log(...args): Stream
Parameters
- Rest ...args: unknown[]
Returns Stream
- Defined in stream.ts:315

`Private` #timeout

#timeout(): Timeout
Returns Timeout
- Defined in stream.ts:297

`Private` #token

#token(): Promise<null | string>
Returns Promise<null | string>
Inherited from Twitch.#token
- Defined in index.ts:184

check

check(users): Promise<{
failed: string[];
success: string[];
}>
Parameters
- users: Data
Returns Promise<{
failed: string[];
success: string[];
}>
Inherited from Twitch.check
- Defined in index.ts:40

ended

ended(listener): Stream
Parameters
- listener: ((stream) => unknown)
  - - (stream): unknown
    - Parameters
      
      stream: LiveStream
      
      Returns unknown
Returns Stream
- Defined in stream.ts:133

fetchAll

fetchAll(users): FetchAllResult
Parameters
- users: string | string[]
Returns FetchAllResult
Inherited from Twitch.fetchAll
- Defined in index.ts:154

getDuration

getDuration(stream, format?): any
Parameters
- stream: LiveStream
- format: string = "w[w], d[d], h[h], m[m], s[s]"
Returns any
- Defined in stream.ts:301

live

live(listener): Stream
Parameters
- listener: ((stream) => unknown)
  - - (stream): unknown
    - Parameters
      
      stream: LiveStream
      
      Returns unknown
Returns Stream
- Defined in stream.ts:121

run

run(): Promise<unknown>
Returns Promise<unknown>
- Defined in stream.ts:167

setDebug

setDebug(bool): Stream
Parameters
- bool: boolean
Returns Stream
Inherited from Twitch.setDebug
- Defined in index.ts:172

setTimer

setTimer(minutes): Stream
Parameters
- minutes: number
Returns Stream
- Defined in stream.ts:97

setToggle

setToggle(type): Stream
Parameters
- type: "live" | "update" | "ended"
Returns Stream
- Defined in stream.ts:35

stream

stream(users): StreamResults
Parameters
- users: Data
Returns StreamResults
Inherited from Twitch.stream
- Defined in index.ts:132

update

update(listener): Stream
Parameters
- listener: ((oldStream, newStream) => unknown)
  - - (oldStream, newStream): unknown
    - Parameters
      
      oldStream: LiveStream
      
      newStream: LiveStream
      
      Returns unknown
Returns Stream
- Defined in stream.ts:126

user

user(users): Results<User[]>
Parameters
- users: Data
Returns Results<User[]>
Inherited from Twitch.user
- Defined in index.ts:114

vods

vods(query): Results<Vod[]>
Parameters
- query: VodQuery
Returns Results<Vod[]>
Inherited from Twitch.vods
- Defined in index.ts:83

Class Stream

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

clientId: string

clientSecret: string

Optional timerMinutes: number

Returns Stream

Properties

Private #announce

Private #announcements

Private #cache

Private #clientId

Private #clientSecret

Private #data

Private #debug

Private #stream

Private #timer

Note

Private #toggles

Type declaration

ended: boolean

live: boolean

update: boolean

bearer

Accessors

announcements

Returns { add: ((user, webhooks) => Stream); list: ((user?) => { user: string; webhooks: string[]; }[]); remove: ((user, webhooks?) => Stream); }

add: ((user, webhooks) => Stream)

Parameters

user: string

webhooks: string[]

Returns Stream

list: ((user?) => { user: string; webhooks: string[]; }[])

Parameters

Optional user: string

Returns { user: string; webhooks: string[]; }[]

remove: ((user, webhooks?) => Stream)

Parameters

user: string

Optional webhooks: string[]

Returns Stream

caches

Returns { add: ((stream) => void); all: (() => LiveStream[]); delete: ((id) => boolean); get: ((id) => undefined | LiveStream); size: (() => number); update: ((stream) => Map<string, LiveStream>); user: ((user) => undefined | LiveStream); }

add: ((stream) => void)

Parameters

stream: LiveStream

Returns void

all: (() => LiveStream[])

Returns LiveStream[]

delete: ((id) => boolean)

Parameters

id: string

Returns boolean

get: ((id) => undefined | LiveStream)

Parameters

id: string

Returns undefined | LiveStream

size: (() => number)

Returns number

update: ((stream) => Map<string, LiveStream>)

Parameters

stream: LiveStream

Returns Map<string, LiveStream>

user: ((user) => undefined | LiveStream)

Parameters

user: string

Returns undefined | LiveStream

toggles

Returns { ended: boolean; live: boolean; update: boolean; }

ended: boolean

live: boolean

update: boolean

users

`Optional` timerMinutes: number

`Private` #announce

`Private` #announcements

`Private` #cache

`Private` #clientId

`Private` #clientSecret

`Private` #data

`Private` #debug

`Private` #stream

`Private` #timer

`Private` #toggles

Returns {
add: ((user, webhooks) => Stream);
list: ((user?) => {
user: string;
webhooks: string[];
}[]);
remove: ((user, webhooks?) => Stream);
}

list: ((user?) => {
user: string;
webhooks: string[];
}[])

`Optional` user: string

Returns {
user: string;
webhooks: string[];
}[]

`Optional` webhooks: string[]

Returns {
add: ((stream) => void);
all: (() => LiveStream[]);
delete: ((id) => boolean);
get: ((id) => undefined | LiveStream);
size: (() => number);
update: ((stream) => Map<string, LiveStream>);
user: ((user) => undefined | LiveStream);
}

Returns {
ended: boolean;
live: boolean;
update: boolean;
}

Returns {
add: ((users) => Stream);
list: (() => string[]);
remove: ((users) => Stream);
}

`Private` #checkIfLive

`Private` #fetch

`Private` #generateToken

`Private` #getURL

`Private` #log

`Rest` ...args: unknown[]

`Private` #timeout

`Private` #token

Returns Promise<{
failed: string[];
success: string[];
}>