Class HaxanFactory<T>

Request factory, supports both options (given in constructor) and a chainable API

Type parameters

T = unknown

Hierarchy

HaxanFactory

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HaxanFactory<T>(url: string, _fetch?: () => (input: RequestInfo, init?: RequestInit) => Promise<Response>, opts?: Partial<Omit<IHaxanOptions, "url">>): HaxanFactory<T>

- Defined in src/client.ts:50
Type parameters
- T = unknown
Parameters
- url: string
- Optional _fetch: () => (input: RequestInfo, init?: RequestInit) => Promise<Response>
  - - (): (input: RequestInfo, init?: RequestInit) => Promise<Response>
    - Returns (input: RequestInfo, init?: RequestInit) => Promise<Response>
      - (input: RequestInfo, init?: RequestInit): Promise<Response>
        
        Parameters
        
        input: RequestInfo
        
        Optional init: RequestInit
        
        Returns Promise<Response>
- Optional opts: Partial<Omit<IHaxanOptions, "url">>
Returns HaxanFactory<T>

Properties

Private _addOptions

_addOptions: Record<string, unknown> = {}

Private _fetch

_fetch: () => (input: RequestInfo, init?: RequestInit) => Promise<Response>

Type declaration

- (): (input: RequestInfo, init?: RequestInit) => Promise<Response>
- Returns (input: RequestInfo, init?: RequestInit) => Promise<Response>
  - - (input: RequestInfo, init?: RequestInit): Promise<Response>
    - Parameters
      - input: RequestInfo
      - Optional init: RequestInit
      Returns Promise<Response>

Private _opts

_opts: IHaxanOptions = ...

Methods

abort

abort(sig: AbortSignal): HaxanFactory<T>

- Defined in src/client.ts:139
Parameters
- sig: AbortSignal
Returns HaxanFactory<T>

addOptions

addOptions<T>(opts: T): HaxanFactory<T>

- Defined in src/client.ts:76
Type parameters
- T: Record<string, unknown>
Parameters
- opts: T
Returns HaxanFactory<T>

body

body(body: unknown): HaxanFactory<T>

- Defined in src/client.ts:121
Parameters
- body: unknown
Returns HaxanFactory<T>

Private buildUrl

buildUrl(): string

- Defined in src/client.ts:241
Returns string

delete

delete(): HaxanFactory<T>

- Defined in src/client.ts:117
Returns HaxanFactory<T>

Private doRequest

doRequest<T>(): Promise<IHaxanResponse<T>>

- Defined in src/client.ts:247
Type parameters
- T
Returns Promise<IHaxanResponse<T>>

execute

execute(): Promise<IHaxanResponse<T>>

- Defined in src/client.ts:170
Returns Promise<IHaxanResponse<T>>

get

get(): HaxanFactory<T>

- Defined in src/client.ts:93
Returns HaxanFactory<T>

getOptions

getOptions(): IHaxanOptions

- Defined in src/client.ts:162
Returns IHaxanOptions

head

head(): HaxanFactory<T>

- Defined in src/client.ts:97
Returns HaxanFactory<T>

header

header(name: string, value: string): HaxanFactory<T>

- Defined in src/client.ts:125
Parameters
- name: string
- value: string
Returns HaxanFactory<T>

method

method(method: string): HaxanFactory<T>

- Defined in src/client.ts:89
Parameters
- method: string
Returns HaxanFactory<T>

Private normalizedBody

normalizedBody(): null | string

- Defined in src/client.ts:143
Returns null | string

options

options(): HaxanFactory<T>

- Defined in src/client.ts:101
Returns HaxanFactory<T>

param

param(name: string, value: unknown): HaxanFactory<T>

- Defined in src/client.ts:130
Parameters
- name: string
- value: unknown
Returns HaxanFactory<T>

Private parseBody

parseBody(res: Response): Promise<T>

- Defined in src/client.ts:154
Parameters
- res: Response
Returns Promise<T>

Private parseResponse

parseResponse(res: Response): Promise<IHaxanResponse<T>>

- Defined in src/client.ts:174
Parameters
- res: Response
Returns Promise<IHaxanResponse<T>>

patch

patch(body: unknown): HaxanFactory<T>

- Defined in src/client.ts:113
Parameters
- body: unknown
Returns HaxanFactory<T>

post

post(body: unknown): HaxanFactory<T>

- Defined in src/client.ts:105
Parameters
- body: unknown
Returns HaxanFactory<T>

put

put(body: unknown): HaxanFactory<T>

- Defined in src/client.ts:109
Parameters
- body: unknown
Returns HaxanFactory<T>

redirect

redirect(value: "follow" | "manual"): HaxanFactory<T>

- Defined in src/client.ts:72
Parameters
- value: "follow" | "manual"
Returns HaxanFactory<T>

request

request(): Promise<IHaxanResponse<T>>

- Defined in src/client.ts:281
Returns Promise<IHaxanResponse<T>>

send

send(): Promise<IHaxanResponse<T>>

- Defined in src/client.ts:166
Returns Promise<IHaxanResponse<T>>

Private setProp

setProp<K>(key: K, value: IHaxanOptions[K]): HaxanFactory<T>

- Defined in src/client.ts:64
Type parameters
- K: keyof IHaxanOptions
Parameters
- key: K
- value: IHaxanOptions[K]
Returns HaxanFactory<T>

timeout

timeout(ms: number): HaxanFactory<T>

- Defined in src/client.ts:135
Parameters
- ms: number
Returns HaxanFactory<T>

type

type(type: ResponseType): HaxanFactory<T>

- Defined in src/client.ts:85
Parameters
- type: ResponseType
Returns HaxanFactory<T>

url

url(url: string): HaxanFactory<T>

- Defined in src/client.ts:81
Parameters
- url: string
Returns HaxanFactory<T>

Generated using TypeDoc