Class default

Hierarchy

default

Index

Constructors

Properties

clientID endpoint

Methods

fetchGameByName fetchTrendingFeed fetchUserByID fetchUserByName request

Constructors

constructor

new default(clientID?: string): default
Parameters
- Optional clientID: string
Returns default
- Defined in index.ts:8

Properties

clientID

clientID: string = 'kimne78kx3ncx6brgo4mv6wki5h1ko'

endpoint

endpoint: string = 'https://gql.twitch.tv/gql'

Methods

fetchGameByName

fetchGameByName(name: string): Promise<TwitchGame>
Fetches a twitch game and returns its info, null if not found.

Returns
Parameters
- name: string
  
  The name of the game. Eg Rocket League.
Returns Promise<TwitchGame>
- Defined in index.ts:94

fetchTrendingFeed

fetchTrendingFeed(limit: number): Promise<undefined | null | NodeStream[]>
Fetches the trending Twitch Feed, null or undefined if not found

Returns
Parameters
- limit: number
  
  The amount of posts to fetch.
Returns Promise<undefined | null | NodeStream[]>
- Defined in index.ts:112

fetchUserByID

fetchUserByID(userID: string): Promise<null | TwitchUser>
Fetches a twitch user and returns their info and streaming status, if there is no user it will return null.

Returns
Parameters
- userID: string
  
  The Twitch ID of the user you want to fetch.
Returns Promise<null | TwitchUser>
- Defined in index.ts:58

fetchUserByName

fetchUserByName(username: string): Promise<null | TwitchUser>
Fetches a twitch user by their username and returns their info and streaming status, if there is no user it will return null.

Returns
Parameters
- username: string
  
  The Twitch ID of the user you want to fetch.
Returns Promise<null | TwitchUser>
- Defined in index.ts:76

request

request(schema: string, variables: object): Promise<TwitchResponse>
Request Twitch Data

Returns
Parameters
- schema: string
  
  The GQL Schema
- variables: object
  
  The variables needed for the request
Returns Promise<TwitchResponse>
- Defined in index.ts:23

Generated using TypeDoc