module@warp-drive/utilities/json-api

Function postQuery()

function postQuery<T, M extends 
  | ObjectValue
  | undefined = 
  | ObjectValue
  | undefined, E extends object = ApiError>(
   type: TypeFromInstance<T>, 
   query?: QueryParamsSource, 
   options?: ConstrainedRequestOptions
): PostQueryRequestOptions<ReactiveDataDocument<T[], M, E>>;
function postQuery(
   type: string, 
   query?: QueryParamsSource, 
   options?: ConstrainedRequestOptions
): PostQueryRequestOptions;

Call Signature

function postQuery<T, M extends 
  | ObjectValue
  | undefined = 
  | ObjectValue
  | undefined, E extends object = ApiError>(
   type: TypeFromInstance<T>, 
   query?: QueryParamsSource, 
   options?: ConstrainedRequestOptions
): PostQueryRequestOptions<ReactiveDataDocument<T[], M, E>>;

Defined in: -private/json-api/query.ts:162

Builds request options to query for resources, usually by a primary type, configured for the url and header expectations of most JSON:API APIs.

See the Builders guide for what request builders do and when to use one.

The key difference between this and query is that this method will send the query as the JSON body of a "POST" request instead of as query params in the url of a "GET" request.

A CacheKey is generated from the url and query params, and used to cache the response in the store.

import { postQuery } from '@warp-drive/utilities/json-api';

const options = postQuery('person', { include: ['pets', 'friends'] });
const data = await store.request(options);

Supplying Options to Modify the Request Behavior

The following options are supported:

• host - The host to use for the request, defaults to the host configured with setBuildURLConfig.
• namespace - The namespace to use for the request, defaults to the namespace configured with setBuildURLConfig.
• resourcePath - The resource path to use for the request, defaults to pluralizing the supplied type
• reload - Whether to forcibly reload the request if it is already in the store, not supplying this option will delegate to the store's CachePolicy, defaulting to false if none is configured.
• backgroundReload - Whether to reload the request if it is already in the store, but to also resolve the promise with the cached value, not supplying this option will delegate to the store's CachePolicy, defaulting to false if none is configured.
• urlParamsSetting - an object containing options for how to serialize the query params (see buildQueryParams)

import { postQuery } from '@warp-drive/utilities/json-api';

const options = postQuery('person', { include: ['pets', 'friends'] }, { reload: true });
const data = await store.request(options);

Type Parameters

T

T

M

M extends | ObjectValue | undefined = | ObjectValue | undefined

E

E extends object = ApiError

Parameters

type

TypeFromInstance<T>

the name of the resource type to query

query?

QueryParamsSource

the query params to send with the request

options?

ConstrainedRequestOptions

options to modify the request behavior

Returns

PostQueryRequestOptions<ReactiveDataDocument<T[], M, E>>

Call Signature

function postQuery(
   type: string, 
   query?: QueryParamsSource, 
   options?: ConstrainedRequestOptions
): PostQueryRequestOptions;

Defined in: -private/json-api/query.ts:167

Builds request options to query for resources, usually by a primary type, configured for the url and header expectations of most JSON:API APIs.

See the Builders guide for what request builders do and when to use one.

The key difference between this and query is that this method will send the query as the JSON body of a "POST" request instead of as query params in the url of a "GET" request.

A CacheKey is generated from the url and query params, and used to cache the response in the store.

import { postQuery } from '@warp-drive/utilities/json-api';

const options = postQuery('person', { include: ['pets', 'friends'] });
const data = await store.request(options);

Supplying Options to Modify the Request Behavior

The following options are supported:

• host - The host to use for the request, defaults to the host configured with setBuildURLConfig.
• namespace - The namespace to use for the request, defaults to the namespace configured with setBuildURLConfig.
• resourcePath - The resource path to use for the request, defaults to pluralizing the supplied type
• reload - Whether to forcibly reload the request if it is already in the store, not supplying this option will delegate to the store's CachePolicy, defaulting to false if none is configured.
• backgroundReload - Whether to reload the request if it is already in the store, but to also resolve the promise with the cached value, not supplying this option will delegate to the store's CachePolicy, defaulting to false if none is configured.
• urlParamsSetting - an object containing options for how to serialize the query params (see buildQueryParams)

import { postQuery } from '@warp-drive/utilities/json-api';

const options = postQuery('person', { include: ['pets', 'friends'] }, { reload: true });
const data = await store.request(options);

Parameters

type

string

the name of the resource type to query

query?

QueryParamsSource

the query params to send with the request

options?

ConstrainedRequestOptions

options to modify the request behavior

Returns

PostQueryRequestOptions