module@warp-drive/utilities
Interface FindRelatedCollectionUrlOptions
ts
interface FindRelatedCollectionUrlOptions {
fieldPath: string;
host?: string;
identifier: { id: string; type: string };
namespace?: string;
op: "findRelatedCollection";
resourcePath?: string;
}Defined in: index.ts:219
buildBaseURL options for a findRelatedCollection request.
Properties
fieldPath
ts
fieldPath: string;Defined in: index.ts:240
The relationship field name, appended to the resource path.
host?
ts
host?: string;Defined in: index.ts:248
Overrides the globally configured host for this call only.
identifier
ts
identifier: {
id: string;
type: string;
};Defined in: index.ts:227
The type and id of the record whose relationship is being fetched.
id
ts
id: string;The resource id.
type
ts
type: string;The resource type.
namespace?
ts
namespace?: string;Defined in: index.ts:252
Overrides the globally configured namespace for this call only.
op
ts
op: "findRelatedCollection";Defined in: index.ts:223
The request operation this URL is for.
resourcePath?
ts
resourcePath?: string;Defined in: index.ts:244
The path segment for the resource, defaults to identifier.type if not provided.