module@warp-drive/utilities
Interface FindRecordUrlOptions
ts
interface FindRecordUrlOptions {
host?: string;
identifier: { id: string; type: string };
namespace?: string;
op: "findRecord";
resourcePath?: string;
}Defined in: index.ts:100
buildBaseURL options for a findRecord request.
Properties
host?
ts
optional host?: string;Defined in: index.ts:125
Overrides the globally configured host for this call only.
identifier
ts
identifier: {
id: string;
type: string;
};Defined in: index.ts:108
The type and id of the record to find.
id
ts
id: string;The resource id.
type
ts
type: string;The resource type.
namespace?
ts
optional namespace?: string;Defined in: index.ts:129
Overrides the globally configured namespace for this call only.
op
ts
op: "findRecord";Defined in: index.ts:104
The request operation this URL is for.
resourcePath?
ts
optional resourcePath?: string;Defined in: index.ts:121
The path segment for the resource, defaults to identifier.type if not provided.