module@warp-drive/utilities

Interface QueryUrlOptions

interface QueryUrlOptions {
  host?: string;
  identifier: { type: string };
  namespace?: string;
  op: "query";
  resourcePath?: string;
}

Defined in: index.ts:146

buildBaseURL options for a query request.

Properties

host?

host?: string;

Defined in: index.ts:167

Overrides the globally configured host for this call only.

---

identifier

identifier: {
  type: string;
};

Defined in: index.ts:154

The type of the records to query.

type

type: string;

The resource type.

---

namespace?

namespace?: string;

Defined in: index.ts:171

Overrides the globally configured namespace for this call only.

---

op

op: "query";

Defined in: index.ts:150

The request operation this URL is for.

---

resourcePath?

resourcePath?: string;

Defined in: index.ts:163

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