Class Connection

Hierarchy

Connection

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Connection(baseURL: string, wsURL: string, useWebSockets?: boolean): Connection

- Defined in src/connection.ts:17
Parameters
- baseURL: string
- wsURL: string
- Optional useWebSockets: boolean
Returns Connection

Properties

Private $baseURL

$baseURL: string

Private Optional $user

$user: User

Private Optional $ws

$ws: WebSocketConnection

Methods

Private checkForErrors

checkForErrors(status: HttpErrorCodes, parsedResponse?: Record<string, unknown>): void

- Defined in src/connection.ts:56
Parameters
- status: HttpErrorCodes
- Optional parsedResponse: Record<string, unknown>
Returns void

Private createUrl

createUrl(endpoint: string): string

- Defined in src/connection.ts:48
Parameters
- endpoint: string
Returns string

getWebSocket

getWebSocket(): undefined | WebSocketConnection

- Defined in src/connection.ts:145
Returns undefined | WebSocketConnection

request

request<T>(method: HttpMethod, endpoint: string, data?: Data, allowedScopes?: Scopes[], skipParsing?: boolean): Promise<T>

- Defined in src/connection.ts:94
Type parameters
- T
Parameters
- method: HttpMethod
- endpoint: string
- Optional data: Data
- Optional allowedScopes: Scopes[]
- Optional skipParsing: boolean
Returns Promise<T>

Private setBearerTokenIfRequired

setBearerTokenIfRequired(headers: any, scopes?: Scopes[]): void

- Defined in src/connection.ts:27
Parameters
- headers: any
- Optional scopes: Scopes[]
Returns void

setUser

setUser(user?: User): void

- Defined in src/connection.ts:149
Parameters
- Optional user: User
Returns void

upload

upload<T>(endpoint: string, body: FormData, allowedScopes: Scopes[]): Promise<T>

- Defined in src/connection.ts:124
Type parameters
- T
Parameters
- endpoint: string
- body: FormData
- allowedScopes: Scopes[]
Returns Promise<T>

Generated using TypeDoc