Skip to content
module@warp-drive/utilities

Interface DeleteRecordUrlOptions ​

ts
interface DeleteRecordUrlOptions {
  host?: string;
  identifier: { id: string; type: string };
  namespace?: string;
  op: "deleteRecord";
  resourcePath?: string;
}

Defined in: index.ts:376

buildBaseURL options for a deleteRecord request.

Properties ​

host? ​

ts
host?: string;

Defined in: index.ts:401

Overrides the globally configured host for this call only.


identifier ​

ts
identifier: {
  id: string;
  type: string;
};

Defined in: index.ts:384

The type and id of the record being deleted.

id ​

ts
id: string;

The resource id.

type ​

ts
type: string;

The resource type.


namespace? ​

ts
namespace?: string;

Defined in: index.ts:405

Overrides the globally configured namespace for this call only.


op ​

ts
op: "deleteRecord";

Defined in: index.ts:380

The request operation this URL is for.


resourcePath? ​

ts
resourcePath?: string;

Defined in: index.ts:397

The path segment for the resource, defaults to identifier.type if not provided.

Released under the MIT License.