Class NodeRequester

Class used to fire HTTP(S) requests.

Hierarchy

NodeRequester

Implements

APIRequester

Index

Constructors

Properties

apiUrl baseUrl cookies oAuthAccessToken headers

Methods

get getMeCookie post setOAuthAccessToken create

Constructors

constructor

new NodeRequester(cookies, baseUrl): NodeRequester
Parameters
- cookies: false | Cookies
  
  Pass false to ignore cookies. Pass a CookieJar to use cookies.
- baseUrl: string
Returns NodeRequester
- Defined in requester/node.ts:24

Properties

`Private` `Readonly` apiUrl

apiUrl: string

`Private` `Readonly` baseUrl

baseUrl: string

cookies

cookies: false | Cookies

Pass false to ignore cookies. Pass a CookieJar to use cookies.

`Private` oAuthAccessToken

oAuthAccessToken: undefined | string = undefined

`Static` `Private` `Readonly` headers

headers: Record<string, string> = ...

Methods

get

get<T>(path, queryString?): Promise<T>
Type Parameters
- T
Parameters
- path: string
- Optional queryString: KeyValue<any>
Returns Promise<T>
Implementation of APIRequester.get
- Defined in requester/node.ts:43

`Private` getMeCookie

getMeCookie(): null | MeCookie
Returns null | MeCookie
- Defined in requester/node.ts:114

post

post<T>(path, body?, ignoreNonce?): Promise<T>
Type Parameters
- T
Parameters
- path: string
- body: KeyValue<any> = {}
- ignoreNonce: boolean = false
Returns Promise<T>
Implementation of APIRequester.post
- Defined in requester/node.ts:70

setOAuthAccessToken

setOAuthAccessToken(accessToken): void
Parameters
- accessToken: string
Returns void
Implementation of APIRequester.setOAuthAccessToken
- Defined in requester/node.ts:31

`Static` create

create(baseUrl?, cookies?): APIRequester
Parameters
- baseUrl: string = PR0GRAMM_BASE_URL
- Optional cookies: Cookies
Returns APIRequester
- Defined in requester/node.ts:36

Generated using TypeDoc