module@warp-drive/utilities/json-api

Interface JSONAPIConfig

interface JSONAPIConfig extends BuildURLConfig {
  extensions?: { [key: string]: string | undefined; atomic?: string };
  host: string | null;
  namespace: string | null;
  profiles?: { [key: string]: string | undefined; pagination?: string };
}

Defined in: -private/json-api/-utils.ts:13

The configuration setBuildURLConfig accepts: the BuildURLConfig fields, plus the {json:api} profile and extension URIs to send in the Accept header.

Extends

• BuildURLConfig

Properties

extensions?

optional extensions?: {
  [key: string]: string | undefined;
  atomic?: string;
};

Defined in: -private/json-api/-utils.ts:18

Index Signature

[key: string]: string | undefined

atomic?

optional atomic?: string;

---

host

host: string | null;

Defined in: index.ts:26

The scheme, domain and port (if any) to prefix built URLs with, e.g. 'https://api.example.com'.

Inherited from

BuildURLConfig.host

---

namespace

namespace: string | null;

Defined in: index.ts:30

The path segment to insert between host and the resource path, e.g. 'api/v1'.

Inherited from

BuildURLConfig.namespace

---

profiles?

optional profiles?: {
  [key: string]: string | undefined;
  pagination?: string;
};

Defined in: -private/json-api/-utils.ts:14

Index Signature

[key: string]: string | undefined

pagination?

optional pagination?: string;