Store - Documentation

Constructor

new Store(config)

Create a store

Source:

index.js, line 7

Parameters:

Name Type Description

config

Object

Options to init new Store

Name	Type	Description
`save`	`bool` \| `number`	If save is number, store save data every number seconds
`directory`	`string`	Path who stores are saved
`name`	`string`	Name of file when save = true

Methods

delete(key)

[Promise] Delete value

Source:

index.js, line 151

Parameters:

Name	Type	Description
`key`	`string`	Key

deleteSync(key)

Delete value

Source:

index.js, line 171

Parameters:

Name	Type	Description
`key`	`string`	Key

get(key) → {any}

[Promise] Get value

Source:

index.js, line 56

Parameters:

Name	Type	Description
`key`	`string`	Key

Returns:

Type:: any

- Return value of key

getSync(key) → {any}

Get value

Source:

index.js, line 67

Parameters:

Name	Type	Description
`key`	`string`	Key

Returns:

Type:: any

- Return value of key

list() → {Array}

[Promise] Get list of key

Source:

index.js, line 185

Returns:

Type:: Array

- Return list of keys

listSync() → {Array}

Get list of key

Source:

index.js, line 197

Returns:

Type:: Array

- Return list of keys

set(key, value)

[Promise] Set value

Source:

index.js, line 76

Parameters:

Name	Type	Description
`key`	`string`	Key
`value`	`any`	Value

setSync(key, value)

Set value

Source:

index.js, line 94

Parameters:

Name	Type	Description
`key`	`string`	Key
`value`	`any`	Value

update(key, value)

[Promise] Update value

Source:

index.js, line 106

Parameters:

Name	Type	Description
`key`	`string`	Key
`value`	`any`	Value

updateSync(key, value)

Update value

Source:

index.js, line 132

Parameters:

Name	Type	Description
`key`	`string`	Key
`value`	`any`	Value