- Preparing search index...
- The search index is not available
Toolkit
Class TransportClientClass
Constructors
constructor
- new TransportClientClass(): TransportClientClass
-
Methods
buildRequest
- buildRequest(url: string, method: RequestMethods, data?: string | File, headers?: any, timeout?: number | Promise<number>, params?: string | URLSearchParams, responseType?: any): RequestWithBlobResponse
-
Parameters
-
url: string
-
method: RequestMethods
-
Optional data: string | File
-
Optional headers: any
-
Optional timeout: number | Promise<number>
-
Optional params: string | URLSearchParams
-
Optional responseType: any
Returns RequestWithBlobResponse
- buildRequest(url: string, method: RequestMethods, data?: string | File | FormData, headers?: any, timeout?: number | Promise<number>, params?: string | URLSearchParams, responseType?: any): Request
-
Parameters
-
url: string
-
method: RequestMethods
-
Optional data: string | File | FormData
-
Optional headers: any
-
Optional timeout: number | Promise<number>
-
Optional params: string | URLSearchParams
-
Optional responseType: any
Returns Request
Private buildUrl
- buildUrl(url: string, params?: string | URLSearchParams): string
-
Parameters
-
url: string
-
Optional params: string | URLSearchParams
Returns string
delete
- delete<T>(url: string, data?: string, headers?: any, timeout?: number | Promise<number>, params?: string): Promise<Response<T>>
-
Parameters
-
url: string
-
Optional data: string
-
Optional headers: any
-
Optional timeout: number | Promise<number>
-
Optional params: string
Returns Promise<Response<T>>
get
- get<T>(url: string, params?: string, headers?: any, timeout?: number | Promise<number>, responseType?: any): Promise<Response<T>>
-
Parameters
-
url: string
-
Optional params: string
-
Optional headers: any
-
Optional timeout: number | Promise<number>
-
Optional responseType: any
Returns Promise<Response<T>>
getBlob
- getBlob(url: string, params?: string, headers?: any, timeout?: number | Promise<number>): Promise<Blob>
-
Parameters
-
url: string
-
Optional params: string
-
Optional headers: any
-
Optional timeout: number | Promise<number>
Returns Promise<Blob>
Private handleTimeout
- handleTimeout(req: XMLHttpRequest, timeout: number | Promise<number>): void
-
Parameters
-
req: XMLHttpRequest
-
timeout: number | Promise<number>
Returns void
Private parseResponse
- parseResponse<T>(request: XMLHttpRequest, accept: DataFormatTypes): Response<T>
-
Parameters
-
request: XMLHttpRequest
-
accept: DataFormatTypes
Returns Response<T>
post
- post<T>(url: string, data?: string | FormData, headers?: any, timeout?: number | Promise<number>, params?: string): Promise<Response<T>>
-
Parameters
-
url: string
-
Optional data: string | FormData
-
Optional headers: any
-
Optional timeout: number | Promise<number>
-
Optional params: string
Returns Promise<Response<T>>
put
- put<T>(url: string, data: string | FormData, headers?: any, timeout?: number | Promise<number>, params?: string): Promise<Response<T>>
-
Parameters
-
url: string
-
data: string | FormData
-
Optional headers: any
-
Optional timeout: number | Promise<number>
-
Optional params: string
Returns Promise<Response<T>>
request
- request(config: RequestWithBlobResponse): Promise<Blob>
-
Parameters
-
config: RequestWithBlobResponse
Returns Promise<Blob>
- request<T>(config: Request): Promise<Response<T>>
-
Returns Promise<Response<T>>
Private setAuthTokenHeader
-
Returns void
Simple service for sending HTTP requests. Used internally by the various clients.