module@warp-drive/utilities/rest

Function deleteRecord()

function deleteRecord<T>(record: T, options?: ConstrainedRequestOptions): DeleteRequestOptions<T>;
function deleteRecord(record: unknown, options?: ConstrainedRequestOptions): DeleteRequestOptions;

Call Signature

function deleteRecord<T>(record: T, options?: ConstrainedRequestOptions): DeleteRequestOptions<T>;

Defined in: -private/rest/save-record.ts:80

Builds request options to delete record for resources, configured for the url, method and header expectations of REST APIs.

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

Basic Usage

import { deleteRecord } from '@warp-drive/utilities/rest';

const person = store.peekRecord('person', '1');

// mark record as deleted
store.deleteRecord(person);

// persist deletion
const data = await store.request(deleteRecord(person));

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 { deleteRecord } from '@warp-drive/utilities/rest';

const person = store.peekRecord('person', '1');

// mark record as deleted
store.deleteRecord(person);

// persist deletion
const options = deleteRecord(person, { namespace: 'api/v1' });
const data = await store.request(options);

Type Parameters

T

T

Parameters

record

T

options?

ConstrainedRequestOptions

Returns

DeleteRequestOptions<T>

Call Signature

function deleteRecord(record: unknown, options?: ConstrainedRequestOptions): DeleteRequestOptions;

Defined in: -private/rest/save-record.ts:81

Builds request options to delete record for resources, configured for the url, method and header expectations of REST APIs.

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

Basic Usage

import { deleteRecord } from '@warp-drive/utilities/rest';

const person = store.peekRecord('person', '1');

// mark record as deleted
store.deleteRecord(person);

// persist deletion
const data = await store.request(deleteRecord(person));

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 { deleteRecord } from '@warp-drive/utilities/rest';

const person = store.peekRecord('person', '1');

// mark record as deleted
store.deleteRecord(person);

// persist deletion
const options = deleteRecord(person, { namespace: 'api/v1' });
const data = await store.request(options);

Parameters

record

unknown

options?

ConstrainedRequestOptions

Returns

DeleteRequestOptions