Skip to content
module@warp-drive/utilities

Interface FindRelatedResourceUrlOptions ​

Defined in: index.ts:247

buildBaseURL options for a findRelatedRecord request.

Properties ​

fieldPath ​

ts
fieldPath: string;

Defined in: index.ts:268

The relationship field name, appended to the resource path.


host? ​

ts
optional host?: string;

Defined in: index.ts:276

Overrides the globally configured host for this call only.


identifier ​

ts
identifier: object;

Defined in: index.ts:255

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:280

Overrides the globally configured namespace for this call only.


op ​

ts
op: "findRelatedRecord";

Defined in: index.ts:251

The request operation this URL is for.


resourcePath? ​

ts
optional resourcePath?: string;

Defined in: index.ts:272

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

Released under the MIT License.