API
Index
Enumerations
BodyCasing
ContentType
HttpCode
HttpMethod
ParsedBodyCacheState
Classes
CFormData
HttpClient
HttpRequestError
HttpResponseError
HttpResponseHeaders
Interfaces
BodyParserOptions
BodySerializerOptions
CFormDataEntryMetadata
CFormDataEntryValue
Endpoint
FetchRequestHandlerOptions
FormDataFromOptions
HttpClientConfig
HttpInterceptorInterface
HttpRequestHandlerOptions
HttpRequestOptions
HttpResponse
HttpResponseOptions
Log
LoggingInterceptorOptions
MockOptions
NormalizedHttpOptions
RawHttpResponse
RedirectionInterceptorOptions
SimpleServer
XhrRequestHandlerOptions
Type aliases
Variables
Functions
Object literals
Type aliases
BodyParser
Ƭ BodyParser: function
Type declaration:
▸ (response: RawHttpResponse): HttpResponse‹T›
Parameters:
BodyParserImplementation
Ƭ BodyParserImplementation: function
Type declaration:
▸ (rawResponse: RawHttpResponse): Promise‹any›
Parameters:
BodySerializer
Ƭ BodySerializer: function
Type declaration:
▸ (request: HttpOptions): NormalizedHttpBody
Parameters:
BufferEncoding
Ƭ BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex"
CFormDataValue
Ƭ CFormDataValue: string | Blob | Readable
CaseConverter
Ƭ CaseConverter: function
Type declaration:
▸ (object: any): any
Parameters:
ContentTypeMap
Ƭ ContentTypeMap: Record‹keyof typeof ContentTypeRegex, T›
HttpBody
Ƭ HttpBody: object | TypedArray | string
HttpFetch
Ƭ HttpFetch: function
Type declaration:
▸ (): Promise‹HttpResponse‹Body››
HttpHeaders
Ƭ HttpHeaders: Record‹string, string | number | boolean | undefined | null›
HttpInterceptor
Ƭ HttpInterceptor: HttpInterceptorFunction | HttpInterceptorInterface
HttpInterceptorFunction
Ƭ HttpInterceptorFunction: function
Type declaration:
▸ <Body>(request: HttpFetch‹Body›, options: NormalizedHttpOptions): HttpFetch‹Body›
Type parameters:
▪ Body
Parameters:
HttpOptions
Ƭ HttpOptions: Partial‹HttpRequestOptions›
HttpRequestHandler
Ƭ HttpRequestHandler: function
Type declaration:
▸ (requestOptions: NormalizedHttpOptions): Promise‹RawHttpResponse›
Parameters:
MockHttpRequestHandler
Ƭ MockHttpRequestHandler: HttpRequestHandler & object
NormalizedHttpBody
Ƭ NormalizedHttpBody: FormData | CFormData | TypedArray | string | undefined
PromiseFunction
Ƭ PromiseFunction: function
Type declaration:
▸ (): Promise‹T›
RequestMode
Ƭ RequestMode: "navigate" | "same-origin" | "no-cors" | "cors"
Variables
Const DEFAULT_REQUEST_TIMEOUT_MS
Const DEFAULT_REQUEST_TIMEOUT_MS• DEFAULT_REQUEST_TIMEOUT_MS: number = 5 * 60 * 1000
Default request timeout - 5 minutes.
Const DONE
Const DONE• DONE: 4 = 4
Const HEADERS_RECEIVED
Const HEADERS_RECEIVED• HEADERS_RECEIVED: 2 = 2
Const SUPPORTS_BROWSER_FORM_DATA
Const SUPPORTS_BROWSER_FORM_DATA• SUPPORTS_BROWSER_FORM_DATA: boolean = (() => { try { return !({} instanceof FormData); } catch { return false; } })()
TypedArray
• TypedArray: any
Const symbol
Const symbol• symbol: unique symbol = Symbol('HttpResponseError')
Functions
Const bodyParser
Const bodyParser▸ bodyParser(__namedParameters: object): BodyParser‹any›
Parameters:
▪Default value __namedParameters: object= {}
Returns: BodyParser‹any›
Const bodySerializer
Const bodySerializer▸ bodySerializer(__namedParameters: object): BodySerializer
Parameters:
▪Default value __namedParameters: object= {}
Returns: BodySerializer
Const cacheParsedBody
Const cacheParsedBody▸ cacheParsedBody<T>(parsedBody: PromiseFunction‹T›): PromiseFunction‹T›
This is not a regular cache! This function is only used across subsequent executions of parsedBody() on a single HttpResponse. To implement cache, make use of interceptors.
Type parameters:
▪ T
Parameters:
Returns: PromiseFunction‹T›
a promise function returning body, it can be called many times
Const createAsyncBodyHandler
Const createAsyncBodyHandler▸ createAsyncBodyHandler<T>(): object
Type parameters:
▪ T
Returns: object
call(): Promise‹T›
onBodyFailure(
failer: function): voidonBodyReceived(
getter: function): void
Const createErrorInterceptor
Const createErrorInterceptor▸ createErrorInterceptor(): HttpInterceptorFunction
Returns: HttpInterceptorFunction
Const createHttpResponse
Const createHttpResponse▸ createHttpResponse(__namedParameters: object): HttpResponse
Parameters:
▪ __namedParameters: object
Returns: HttpResponse
Const createLoggingInterceptor
Const createLoggingInterceptor▸ createLoggingInterceptor(__namedParameters: object): HttpInterceptorFunction
Parameters:
▪ __namedParameters: object
Returns: HttpInterceptorFunction
Const createRedirectionInterceptor
Const createRedirectionInterceptor▸ createRedirectionInterceptor(__namedParameters: object): HttpInterceptorFunction
Parameters:
▪Default value __namedParameters: object= {}
Returns: HttpInterceptorFunction
Const createSimpleServer
Const createSimpleServer▸ createSimpleServer(): SimpleServer
Returns: SimpleServer
Const deepKeyMap
Const deepKeyMap▸ deepKeyMap(object: any, mapper: function): any
Parameters:
▪ object: any
▪ mapper: function
▸ (key: string): string
Parameters:
Returns: any
Const defaultHeaders
Const defaultHeaders▸ defaultHeaders(_host: string): object
Parameters:
Returns: object
Accept: string = "application/json,application/vnd.api+json"
Content-Type: ContentType = ContentType.JSON
Const encodeArrayBuffer
Const encodeArrayBuffer▸ encodeArrayBuffer(data: TypedArray | string | undefined, encoding: BufferEncoding): Uint8Array‹›
Parameters:
Returns: Uint8Array‹›
Const encodeText
Const encodeText▸ encodeText(buffer: ArrayBuffer, encoding: string): string
Parameters:
Returns: string
Const fetchRequestHandler
Const fetchRequestHandler▸ fetchRequestHandler(fetchRequestHandlerOptions: FetchRequestHandlerOptions): HttpRequestHandler
Creates a new HttpRequestHandler that uses Fetch API underneath. Does not support timeout property. Abort is possible only after headers were received.
Parameters:
Returns: HttpRequestHandler
Const getBoundaryFromContentTypeHeader
Const getBoundaryFromContentTypeHeader▸ getBoundaryFromContentTypeHeader(header: string[]): string
Parameters:
Returns: string
Const getCaseConverter
Const getCaseConverter▸ getCaseConverter(bodyCasing?: BodyCasing): toCamelCase
Parameters:
Returns: toCamelCase
Const getEncodingFromHeaders
Const getEncodingFromHeaders▸ getEncodingFromHeaders(headers: HttpResponseHeaders | undefined, fallback: string): string
Parameters:
Returns: string
Const getFileMeta
Const getFileMeta▸ getFileMeta(value: Blob | Readable, existingMeta?: CFormDataEntryMetadata): object | object
Parameters:
Returns: object | object
Const getHeader
Const getHeader▸ getHeader(headers: HttpHeaders | undefined, header: string): string | undefined
Parameters:
Returns: string | undefined
Const getHostname
Const getHostname▸ getHostname(url: string): string
Parameters:
Returns: string
Const handleRequest
Const handleRequest▸ handleRequest(code: number, body: any, contentType: string): Promise‹HttpResponse›
Parameters:
Returns: Promise‹HttpResponse›
Const httpRequestHandler
Const httpRequestHandler▸ httpRequestHandler(requestHandlerOptions: HttpRequestHandlerOptions): HttpRequestHandler
Creates a new HttpRequestHandler that uses native Node.js HTTP & HTTPS modules underneath. Does not support mode property.
Parameters:
Returns: HttpRequestHandler
Const isBlob
Const isBlob▸ isBlob(value: any): value is Blob
Parameters:
Returns: value is Blob
Const isBrowserFormData
Const isBrowserFormData▸ isBrowserFormData(value: any): value is FormData
Parameters:
Returns: value is FormData
Const isHttpInterceptorInterface
Const isHttpInterceptorInterface▸ isHttpInterceptorInterface(interceptor: HttpInterceptor): interceptor is HttpInterceptorInterface
Parameters:
Returns: interceptor is HttpInterceptorInterface
Const isHttpRequestError
Const isHttpRequestError▸ isHttpRequestError(error: any): error is HttpRequestError
Parameters:
Returns: error is HttpRequestError
Const isHttpResponseError
Const isHttpResponseError▸ isHttpResponseError(error: any): error is HttpResponseError
Parameters:
Returns: error is HttpResponseError
Const mockRequestHandler
Const mockRequestHandler▸ mockRequestHandler(mockOptions: MockOptions): MockHttpRequestHandler
Parameters:
Returns: MockHttpRequestHandler
Const noConversion
Const noConversion▸ noConversion(object: any): any
Parameters:
Returns: any
Const parseHeaders
Const parseHeaders▸ parseHeaders(headers: Headers): Record‹string, string›
Parameters:
Returns: Record‹string, string›
Const processMultipartBody
Const processMultipartBody▸ processMultipartBody(body: string, boundary: string): never
Parameters:
Returns: never
Const readBlob
Const readBlob▸ readBlob(blob: Blob): Promise‹Buffer›
Parameters:
Returns: Promise‹Buffer›
Const sanitizeHeaders
Const sanitizeHeaders▸ sanitizeHeaders(...multipleHeaders: undefined | object[]): Record‹string, string›
Parameters:
Returns: Record‹string, string›
Const sleep
Const sleep▸ sleep(ms: number): Promise‹unknown›
Parameters:
Returns: Promise‹unknown›
Const splitWords
Const splitWords▸ splitWords(text: string): string[]
Parameters:
Returns: string[]
switchContentType
▸ switchContentType<T>(contentType: string, map: ContentTypeMap‹T›, defaultResult: T): T
Type parameters:
▪ T
Parameters:
Returns: T
▸ switchContentType<T>(contentType: string, map: ContentTypeMap‹T›): T | undefined
Type parameters:
▪ T
Parameters:
Returns: T | undefined
Const toCamelCase
Const toCamelCase▸ toCamelCase(object: any): any
Parameters:
Returns: any
Const toKebabCase
Const toKebabCase▸ toKebabCase(object: any): any
Parameters:
Returns: any
Const toPascalCase
Const toPascalCase▸ toPascalCase(object: any): any
Parameters:
Returns: any
Const toScreamingSnakeCase
Const toScreamingSnakeCase▸ toScreamingSnakeCase(object: any): any
Parameters:
Returns: any
Const toSnakeCase
Const toSnakeCase▸ toSnakeCase(object: any): any
Parameters:
Returns: any
Const toUrlEncoded
Const toUrlEncoded▸ toUrlEncoded(obj: object): string
Parameters:
Returns: string
Const urlCombine
Const urlCombine▸ urlCombine(sourceUrl: string, sourceQuery?: undefined | object, options?: qs.IStringifyOptions): string
Parameters:
Returns: string
Const urlDecode
Const urlDecode▸ urlDecode<T>(value: string, options?: qs.IParseOptions): T
Type parameters:
▪ T
Parameters:
Returns: T
Const urlDestruct
Const urlDestruct▸ urlDestruct(url: string, options?: qs.IParseOptions): object
Parameters:
Returns: object
query: any
url: string
Const urlEncode
Const urlEncode▸ urlEncode(value: any, options?: qs.IStringifyOptions): string
Parameters:
Returns: string
Const useInterceptor
Const useInterceptor▸ useInterceptor(normalizedOptions: NormalizedHttpOptions): (Anonymous function)
Parameters:
Returns: (Anonymous function)
Const xhrRequestHandler
Const xhrRequestHandler▸ xhrRequestHandler(_?: XhrRequestHandlerOptions): HttpRequestHandler
Parameters:
Returns: HttpRequestHandler
Object literals
Const ContentTypeRegex
Const ContentTypeRegex▪ ContentTypeRegex: object
JSON
• JSON: RegExp‹› = /^application/(json|.++json)$/
MULTIPART
• MULTIPART: RegExp‹› = /^multipart//
TEXT
• TEXT: RegExp‹› = /^text//
URL_ENCODED
• URL_ENCODED: RegExp‹› = /^application/x-www-form-urlencoded$/
Const HttpClientHelper
Const HttpClientHelper▪ HttpClientHelper: object
defaultHeaders
• defaultHeaders: defaultHeaders
getHostname
• getHostname: getHostname
toUrlEncoded
• toUrlEncoded: toUrlEncoded
Const HttpStatusText
Const HttpStatusText▪ HttpStatusText: object
__computed
• __computed: string = "Network Authentication Required"
Const Interceptors
Const Interceptors▪ Interceptors: object
createErrorInterceptor
• createErrorInterceptor: createErrorInterceptor
createLoggingInterceptor
• createLoggingInterceptor: createLoggingInterceptor
createRedirectionInterceptor
• createRedirectionInterceptor: createRedirectionInterceptor
Last updated