JSDoc: Class: MemoryStore

Constructor

new MemoryStore(optionsopt)

Parameters:

Name Type Attributes Description

options

object

Store options

Properties

Name	Type	Attributes	Description
`idField`	string	<optional>	Name of the identifier field
`items`	Array.<object>	<optional>	Items to seed the store with

Source:

store.js, line 13

Classes

MemoryStore

Methods

clear() → {void}

Remove every item.

Source:

store.js, line 129

Returns:

Type: void

create(body) → {object}

Create an item, assigning an identifier when the body does not carry one.

Parameters:

Name	Type	Description
`body`	object	Item body

Source:

store.js, line 67

Returns:

Created item

Type: object

get(id) → {object|undefined}

Read one item.

Parameters:

Name	Type	Description
`id`	*	Identifier

Source:

store.js, line 57

Returns:

Item, or undefined when absent

Type: object | undefined

list(query) → {Object}

Run a collection query against the store.

Parameters:

Name	Type	Description
`query`	object	Query from `parseCollectionQuery`

Source:

store.js, line 47

Returns:

Collection envelope

Type: Object

normalizeId(id) → {*}

Normalise an identifier so that "1" from a path matches the stored 1.

Parameters:

Name	Type	Description
`id`	*	Raw identifier

Source:

store.js, line 34

Returns:

Normalised identifier

Type: *

patch(id, body) → {object|undefined}

Merge changes into an item.

Parameters:

Name	Type	Description
`id`	*	Identifier
`body`	object	Partial body

Source:

store.js, line 103

Returns:

Updated item, or undefined when absent

Type: object | undefined

remove(id) → {boolean}

Delete an item.

Parameters:

Name	Type	Description
`id`	*	Identifier

Source:

store.js, line 120

Returns:

True when an item was deleted

Type: boolean

update(id, body) → {object|undefined}

Replace an item.

Parameters:

Name	Type	Description
`id`	*	Identifier
`body`	object	Replacement body

Source:

store.js, line 86

Returns:

Updated item, or undefined when absent

Type: object | undefined