Class ClientDocument`Experimental`

Some helpers for constructing a document to POST to a server

Hierarchy

ClientDocument

Index

Constructors

Properties

Accessors

Methods

includeResource includeResources setAttribute setRelationship

Constructors

constructor

new ClientDocument(resourceType: string, id?: string): ClientDocument
Parameters
- resourceType: string
- Optional id: string
Returns ClientDocument
- Defined in src/index.ts:927

Properties

`Private` `Readonly` rawData

rawData: ClientJsonApiDocument

Accessors

data

get data(): ClientJsonApiDocument
Experimental
The raw JSON:API data

Returns ClientJsonApiDocument
- Defined in src/index.ts:967

Methods

includeResource

includeResource(resource: ResourceObject): void
Experimental
Adds the resource to included
Parameters
- resource: ResourceObject
Returns void
- Defined in src/index.ts:951

includeResources

includeResources(resources: ResourceObject[]): void
Experimental
Adds the resources to included
Parameters
- resources: ResourceObject[]
Returns void
- Defined in src/index.ts:959

setAttribute

setAttribute(name: string, value: string): void
Experimental
Sets a primary resource attribute
Parameters
- name: string
- value: string
Returns void
- Defined in src/index.ts:935

setRelationship

setRelationship(name: string, resourceIdentifier: ResourceIdentifierObject | ResourceIdentifierObject[]): void
Experimental
Adds a named relationship to a resource
Parameters
- name: string
- resourceIdentifier: ResourceIdentifierObject | ResourceIdentifierObject[]
Returns void
- Defined in src/index.ts:943

Generated using TypeDoc