Type aliases
CONNECT
CONNECT: "CONNECT"
DELETE
DELETE: "DELETE"
GET
GET: "GET"
HEAD
HEAD: "HEAD"
METHOD
OPTIONS
OPTIONS: "OPTIONS"
PATCH
PATCH: "PATCH"
POST
POST: "POST"
PUT
PUT: "PUT"
Progress
Progress: { lengthComputable: boolean; loaded: number; total: number }
Type declaration
-
lengthComputable: boolean
-
loaded: number
-
total: number
RequestFn
Type parameters
RequestFunction
Type parameters
RequestOptions
RequestOpts
Request
Opts<Method, Type>: { accept?: string; agent?: { cert: string; key: string }; attach?: {}; auth?: { password: string; user: string }; contentType?: string; headers?: {}; method: Method; onTimeout?: (x: Progress) => void; progress?: (x: Progress) => void; query?: string | Record<string, string | number | boolean>; responseType?: Type; send?: string | Blob | Record<string, any> | BufferSource | FormData | URLSearchParams | ReadableStream; timeout?: number; uploadProgress?: (x: Progress) => void; url: string }
Type parameters
Type declaration
-
Optional accept?: string
-
Optional agent?: { cert: string; key: string }
-
Optional attach?: {}
-
[field: string]: Blob | File
-
Optional auth?: { password: string; user: string }
-
password: string
-
user: string
-
Optional contentType?: string
-
Optional headers?: {}
-
method: Method
-
Optional onTimeout?: (x: Progress) => void
-
Optional progress?: (x: Progress) => void
-
Optional query?: string | Record<string, string | number | boolean>
-
Optional responseType?: Type
-
Optional send?: string | Blob | Record<string, any> | BufferSource | FormData | URLSearchParams | ReadableStream
-
Optional timeout?: number
-
Optional uploadProgress?: (x: Progress) => void
-
url: string
Response
Response<T>: { data: T; status: number }
Type parameters
ResponseType
ResponseType: "raw_text" | "binary" | "parsed"
Result
Result<T>
: { abort
: () => void; promise
: Promise<Response<T>> }
Type parameters
Type declaration
-
abort: () => void
-
promise: Promise<Response<T>>
ResultMapping
ResultMapping<T>: { binary: ArrayBuffer; parsed: T; raw_text: string }
Type parameters
Type declaration
-
binary: ArrayBuffer
-
parsed: T
-
raw_text: string
Serializer
Serializer: { convert?: (obj: any) => string; parse?: (data: string) => any }
Type declaration
-
Optional convert?: (obj: any) => string
-
-
Parameters
Returns string
-
Optional parse?: (data: string) => any
TRACE
TRACE: "OPTIONS"
Credentials for HTTP basic auth