JsonApiClient

Hierarchy

• JsonApiClient

Index

Constructors

• constructor

Properties

• httpClient

Methods

• get

• getList

• patch

• post

• put

• remove

Constructors

constructor

+ new JsonApiClient(httpClient: HttpClient): JsonApiClient

Defined in jsonApi.client.ts:9

Parameters:

Name	Type
httpClient	HttpClient

Returns: JsonApiClient

Properties

httpClient

• httpClient: HttpClient

Defined in jsonApi.client.ts:10

Methods

get

▸ get<D, M>(uri: string): GetBuilder‹RawResponse‹D, M››

Defined in jsonApi.client.ts:13

Type parameters:

▪ D: AnyData

▪ M: object

Parameters:

Name	Type
uri	string

Returns: GetBuilder‹RawResponse‹D, M››

getList

▸ getList<D, M>(uri: string): GetListBuilder‹RawListResponse‹D, M›, object›

Defined in jsonApi.client.ts:17

Type parameters:

▪ D: AnyData

▪ M: ListMetaData

Parameters:

Name	Type
uri	string

Returns: GetListBuilder‹RawListResponse‹D, M›, object›

patch

▸ patch<D, M>(uri: string): UpdateBuilder‹RawResponse‹D, M››

Defined in jsonApi.client.ts:33

Type parameters:

▪ D: AnyData

▪ M: object

Parameters:

Name	Type
uri	string

Returns: UpdateBuilder‹RawResponse‹D, M››

post

▸ post<D, M>(uri: string): PostBuilder‹RawResponse‹D, M››

Defined in jsonApi.client.ts:21

Type parameters:

▪ D: AnyData

▪ M: object

Parameters:

Name	Type
uri	string

Returns: PostBuilder‹RawResponse‹D, M››

put

▸ put<D, M>(uri: string): UpdateBuilder‹RawResponse‹D, M››

Defined in jsonApi.client.ts:29

Type parameters:

▪ D: AnyData

▪ M: object

Parameters:

Name	Type
uri	string

Returns: UpdateBuilder‹RawResponse‹D, M››

remove

▸ remove<D, M>(uri: string): RemoveBuilder‹RawResponse‹D, M››

Defined in jsonApi.client.ts:25

Type parameters:

▪ D: AnyData

▪ M: object

Parameters:

Name	Type
uri	string

Returns: RemoveBuilder‹RawResponse‹D, M››