Skip to content
module@warp-drive/utilities

Interface FindRelatedCollectionUrlOptions

Defined in: index.ts:206

buildBaseURL options for a findRelatedCollection request.

Properties

fieldPath

ts
fieldPath: string;

Defined in: index.ts:227

The relationship field name, appended to the resource path.


host?

ts
optional host?: string;

Defined in: index.ts:235

Overrides the globally configured host for this call only.


identifier

ts
identifier: object;

Defined in: index.ts:214

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
optional namespace?: string;

Defined in: index.ts:239

Overrides the globally configured namespace for this call only.


op

ts
op: "findRelatedCollection";

Defined in: index.ts:210

The request operation this URL is for.


resourcePath?

ts
optional resourcePath?: string;

Defined in: index.ts:231

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

Released under the MIT License.