apion

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

json

Functions

Type aliases

ActionConstructor

ActionConstructor: Constructor<K, T, R> | RequestBuilder<R>

Applicator

Applicator: function

Type declaration

- (value: T, ctx: C): R
- Parameters
  - value: T
  - ctx: C
  Returns R

Apply

Apply: Applicator<T, C> | T

BuiltClient

BuiltClient: Lambda<A, Record<keyof X, any>> | function & object | function & object | function | Record<keyof X, any>

BuiltClient2

BuiltClient2: BuiltClient2<A, X>

Constructor

Constructor: Lambda<T, R> | Lambda<T, function>

ContextualBuilder

ContextualBuilder: Update<C, ConfigBuilder<any, string>>

ContextualTransform

ContextualTransform: Applicator<T, C, R>

ContextualUpdate

ContextualUpdate: Applicator<T, C, R> | R

GenericGroupBuilder

GenericGroupBuilder: GroupBuilder<any, string, any, any>

Handler

Handler: Lambda<A, Record<K, any>>

Lambda

Lambda: function

Type declaration

- (...args: A): R
- Parameters
  - Rest ...args: A
  Returns R

Merger

Merger: function

Type declaration

- (prev: T, next: T): T
- Parameters
  - prev: T
  - next: T
  Returns T

NameOf

NameOf: NameOf<T>

Transformer

Transformer: function

Type declaration

- (value: T): R
- Parameters
  - value: T
  Returns R

Update

Update: Transformer<T, R> | R

Variables

Const json

json: ConfigBuilder<Object, "json"> = apion.config('json').headers({ [Header.CONTENT_TYPE]: 'application/json' }).formatter((body: any) =>typeof body === 'string' ? body : JSON.stringify(body)).parser((body: any) => {try {return body && JSON.parse(body);} catch (e) {throw new Error('unable to parse body as JSON');}})

Functions

action

action<K, A, C>(name: K, ctorOrBuilder?: Constructor<K, A, C> | RequestBuilder<C>): ActionBuilder<C, K, __type, A>

- Defined in index.ts:28
Type parameters
- K: string
- A: any[]
- C: object
Parameters
- name: K
- Optional ctorOrBuilder: Constructor<K, A, C> | RequestBuilder<C>
Returns ActionBuilder<C, K, __type, A>

builder

builder<C>(formatter?: Transformer<C>): RequestBuilder<C>

- Defined in index.ts:9
Type parameters
- C: object
Parameters
- Optional formatter: Transformer<C>
Returns RequestBuilder<C>

compose

compose(...transforms: Array<function>): any

- Defined in utils.ts:11
Parameters
- Rest ...transforms: Array<function>
Returns any

config

config<T, K>(name?: K): ConfigBuilder<T, K>

- Defined in index.ts:15
Type parameters
- T: object
- K: string
Parameters
- Optional name: K
Returns ConfigBuilder<T, K>

fromEntries

fromEntries<K, V>(entries: Array<[K, V]>): Record<K, V>

- Defined in utils.ts:1
Type parameters
- K: string | number | symbol
- V
Parameters
- entries: Array<[K, V]>
Returns Record<K, V>

group

group<K, A, C>(name: K, ctor?: Constructor<K, A, C>): GroupBuilder<C, K, __type, A>

- Defined in index.ts:21
Type parameters
- K: string
- A: any[]
- C: object
Parameters
- name: K
- Optional ctor: Constructor<K, A, C>
Returns GroupBuilder<C, K, __type, A>

identity

identity<T>(value: T): T

- Defined in utils.ts:18
Type parameters
- T
Parameters
- value: T
Returns T

normalizeHeaders

normalizeHeaders(headers: Record<string, string>): Record<string, string>

- Defined in context/request.ts:11
Parameters
- headers: Record<string, string>
Returns Record<string, string>

resolveDynamicBuilder

resolveDynamicBuilder<T>(dynamicBuilder: Transformer<T, ConfigBuilder<any, string>>, context: T): ConfigBuilder<any, string>

- Defined in builders/client/config.ts:12
Type parameters
- T
Parameters
- dynamicBuilder: Transformer<T, ConfigBuilder<any, string>>
- context: T
Returns ConfigBuilder<any, string>

wrapResolver

wrapResolver<T, C>(handler: ContextualUpdate<C, T>, merge?: Merger<T>): function

- Defined in builders/client/http.ts:7
Type parameters
- T
- C
Parameters
- handler: ContextualUpdate<C, T>
- Optional merge: Merger<T>
Returns function
- - (prev?: T, ctx?: any): T
  - Parameters
    - Optional prev: T
    - Optional ctx: any
    Returns T

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ActionConstructor

Applicator

Type declaration

Parameters

value: T

ctx: C

Returns R

Apply

BuiltClient

BuiltClient2

Constructor

ContextualBuilder

ContextualTransform

ContextualUpdate

GenericGroupBuilder

Handler

Lambda

Type declaration

Parameters

Rest ...args: A

Returns R

Merger

Type declaration

Parameters

prev: T

next: T

Returns T

NameOf

Transformer

Type declaration

Parameters

value: T

Returns R

Update

Variables

Const json

Functions

action

Type parameters

K: string

A: any[]

C: object

Parameters

name: K

Optional ctorOrBuilder: Constructor<K, A, C> | RequestBuilder<C>

Returns ActionBuilder<C, K, __type, A>

builder

Type parameters

C: object

Parameters

Optional formatter: Transformer<C>

Returns RequestBuilder<C>

compose

Parameters

Rest ...transforms: Array<function>

Returns any

config

Type parameters

T: object

K: string

Parameters

Optional name: K

Returns ConfigBuilder<T, K>

fromEntries

Type parameters

K: string | number | symbol

V

Parameters

entries: Array<[K, V]>

Returns Record<K, V>

group

Type parameters