module@warp-drive/utilities/json-api

Builder query()

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

Call Signature

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

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

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 postQuery is that this method will send the query as query params in the url of a "GET" request instead of as the JSON body of a "POST" request.

Basic Usage

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

const data = await store.request(query('person'));

With Query Params

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

const options = query('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 { query } from '@warp-drive/utilities/json-api';

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

Type Parameters

T

T extends TypedRecordInstance

M

M extends | ObjectValue | undefined = | ObjectValue | undefined

E

E extends object = ApiError

Parameters

type

TypeFromInstance<T>

query?

QueryParamsSource

options?

ConstrainedRequestOptions

Returns

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

Call Signature

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

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

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 postQuery is that this method will send the query as query params in the url of a "GET" request instead of as the JSON body of a "POST" request.

Basic Usage

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

const data = await store.request(query('person'));

With Query Params

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

const options = query('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 { query } from '@warp-drive/utilities/json-api';

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

Parameters

type

string

query?

QueryParamsSource

options?

ConstrainedRequestOptions

Returns

QueryRequestOptions