module@warp-drive/utilities

Interface FindRecordUrlOptions

interface FindRecordUrlOptions {
  host?: string;
  identifier: { id: string; type: string };
  namespace?: string;
  op: "findRecord";
  resourcePath?: string;
}

Defined in: index.ts:108

buildBaseURL options for a findRecord request.

Properties

host?

host?: string;

Defined in: index.ts:133

Overrides the globally configured host for this call only.

---

identifier

identifier: {
  id: string;
  type: string;
};

Defined in: index.ts:116

The type and id of the record to find.

id

id: string;

The resource id.

type

type: string;

The resource type.

---

namespace?

namespace?: string;

Defined in: index.ts:137

Overrides the globally configured namespace for this call only.

---

op

op: "findRecord";

Defined in: index.ts:112

The request operation this URL is for.

---

resourcePath?

resourcePath?: string;

Defined in: index.ts:129

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