Skip to content
module@warp-drive/utilities

Interface CreateRecordUrlOptions ​

ts
interface CreateRecordUrlOptions {
  host?: string;
  identifier: { type: string };
  namespace?: string;
  op: "createRecord";
  resourcePath?: string;
}

Defined in: index.ts:304

buildBaseURL options for a createRecord request.

Properties ​

host? ​

ts
host?: string;

Defined in: index.ts:325

Overrides the globally configured host for this call only.


identifier ​

ts
identifier: {
  type: string;
};

Defined in: index.ts:312

The type of the record being created.

type ​

ts
type: string;

The resource type.


namespace? ​

ts
namespace?: string;

Defined in: index.ts:329

Overrides the globally configured namespace for this call only.


op ​

ts
op: "createRecord";

Defined in: index.ts:308

The request operation this URL is for.


resourcePath? ​

ts
resourcePath?: string;

Defined in: index.ts:321

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

Released under the MIT License.