JSDoc: Namespace: actions

Pinia actions, used via this.$store.dispatch, e.g.: this.$store.dispatch('jv/get', <args>)

args can be either a string or an object representing the item(s) required, or it can be an array of string/object and an optional axios config object.

Source:

actions.js, line 1

Methods

(static) addRecords(records)

Add record(s) to the store, according to mergeRecords config option

Parameters:

Name	Type	Description
`records`	object	The record(s) to be added

Source:

actions.js, line 389

(static) clearRecords(records)

Delete all records from the store (of a given type) other than those included in a given record

Parameters:

Name	Type	Description
`records`	object	A record with type set.

Source:

actions.js, line 397

(async, static) create()

Alias for module:pinia-jsonapi.createJsonapiStore.actions.post

Source:

actions.js, line 373

(async, static) delete(args) → {object}

Delete an item from the API

Parameters:

Name	Type	Description
`args`	string \| object \| array	See `module:pinia-jsonapi.createJsonapiStore.actions` for a summary of args
	string	A URL path to an item - e.g. `endpoint/1`
	object	A restructured object - e.g. `{ _jv: { type: "endpoint", id: "1" } }`
	array	A 2-element array, consisting of a string/object and an optional axios config object

Source:

actions.js, line 328

Returns:

Restructured representation of the deleted item

Type: object

(static) deleteRecord(record)

Delete a record from the store.

Parameters:

Name	Type	Description
`record`	string \| object	The record to be deleted

Source:

actions.js, line 405

(async, static) deleteRelated(args) → {object}

DELETE an object's relationships via its relationships URL

Parameters:

Name	Type	Description
`args`	object	A restructured object, specifying relationship(s) - e.g. `{ _jv: { type: "endpoint", id: "1", relationships: {...} } }`

Source:

actions.js, line 218

Returns:

Restructured representation of the 'parent' item

Type: object

(async, static) fetch()

Alias for module:pinia-jsonapi.createJsonapiStore.actions.get

Source:

actions.js, line 365

(async, static) get(args) → {object}

Get items from the API

Parameters:

Name	Type	Description
`args`	string \| object \| array	See `module:pinia-jsonapi.createJsonapiStore.actions` for a summary of args
	string	A URL path to an item - e.g. `endpoint/1`
	object	A restructured object - e.g. `{ _jv: { type: "endpoint", id: "1" } }`
	array	A 2-element array, consisting of a string/object and an optional axios config object

Source:

actions.js, line 83

Returns:

Restructured representation of the requested item(s)

Type: object

(async, static) getRelated(args) → {object}

Get related items from the API

Parameters:

Name	Type	Description
`args`	string \| object \| array	See `module:pinia-jsonapi.createJsonapiStore.actions` for a summary of args
	string	A URL path to an item - e.g. `endpoint/1`
	object	A restructured object - e.g. `{ _jv: { type: "endpoint", id: "1" } }`
	array	A 2-element array, consisting of a string/object and an optional axios config object

Source:

actions.js, line 123

Returns:

Restructured representation of the requested item(s)

Type: object

(static) mergeRecords(records)

Merge (or add) records to the store

Parameters:

Name	Type	Description
`records`	object	The record(s) to be merged

Source:

actions.js, line 425

(async, static) patch(args) → {object}

Patch an item in the API

Parameters:

Name	Type	Description
`args`	object \| array	See `module:pinia-jsonapi.createJsonapiStore.actions` for a summary of args
	object	A restructured object - e.g. `{ _jv: { type: "endpoint", id: "1" } }`
	array	A 2-element array, consisting of a string/object and an optional axios config object

Source:

actions.js, line 285

Returns:

Restructured representation of the patched item

Type: object

(async, static) patchRelated(args) → {object}

PATCH an object's relationships via its relationships URL

Parameters:

Name	Type	Description
`args`	object	A restructured object, specifying relationship(s) - e.g. `{ _jv: { type: "endpoint", id: "1", relationships: {...} } }`

Source:

actions.js, line 229

Returns:

Restructured representation of the 'parent' item

Type: object

(async, static) post(args) → {object}

Post an item to the API

Parameters:

Name	Type	Description
`args`	object \| array	See `module:pinia-jsonapi.createJsonapiStore.actions` for a summary of args
	object	A restructured object - e.g. `{ _jv: { type: "endpoint", id: "1" } }`
	array	A 2-element array, consisting of a string/object and an optional axios config object

Source:

actions.js, line 253

Returns:

Restructured representation of the posted item

Type: object

(async, static) postRelated(args) → {object}

POST to an object's relationships via its relationships URL

Parameters:

Name	Type	Description
`args`	object	A restructured object, specifying relationship(s) - e.g. `{ _jv: { type: "endpoint", id: "1", relationships: {...} } }`

Source:

actions.js, line 240

Returns:

Restructured representation of the 'parent' item

Type: object

(static) replaceRecords(records)

Replace (or add) record(s) to the store

Parameters:

Name	Type	Description
`records`	object	The record(s) to be replaced

Source:

actions.js, line 433

(async, static) search(args) → {object}

Get items from the API without updating the Pinia store

Parameters:

Name	Type	Description
`args`	string \| object \| array	See `module:pinia-jsonapi.createJsonapiStore.actions` for a summary of args
	string	A URL path to an item - e.g. `endpoint/1`
	object	A restructured object - e.g. `{ _jv: { type: "endpoint", id: "1" } }`
	array	A 2-element array, consisting of a string/object and an optional axios config object

Source:

actions.js, line 356

See:

module:pinia-jsonapi.createJsonapiStore.actions.get

Returns:

Restructured representation of the posted item

Type: object

(async, static) update()

Alias for module:pinia-jsonapi.createJsonapiStore.actions.patch

Source:

actions.js, line 381

(async, static) writeRelated(args, args) → {object}

Internal method to 'write' related items from the API. This method is wrapped by (delete|patch|post)Related actions, and is not available directly as an action.

Parameters:

Name	Type	Description
`args`	object	A restructured object, specifying relationship(s) - e.g. `{ _jv: { type: "endpoint", id: "1", relationships: {...} } }`
`args`	object	A restructured object, specifying relationship(s) - e.g. `{ _jv: { type: "endpoint", id: "1", relationships: {...} } }`

Source:

actions.js, line 30

Returns:

Restructured representation of the 'parent' item

Type: object