ChartIQ SDK Documentation

Class: NameValueStoreLarge

CIQ. NameValueStoreLarge ( [params])

IndexedDB-backed name/value store for large objects such as workspace snapshots. Implements the same callback interface as CIQ.NameValueStore. Falls back to CIQ.NameValueStore automatically when IDB is unavailable (see defaultConfiguration.js).

new NameValueStoreLarge( [params])

Parameters:

Name Type Argument Description

params

object

Properties

Name	Type	Argument	Default
`dbName`	string	<optional>	"NameValueStoreLarge"
`storeName`	string	<optional>	"keyvalue"
`version`	number	<optional>	1

Since:

10.5.0

Methods

<static> NameValueStoreLarge#get(field, cb)

Retrieves a value from the store.

Parameters:

Name	Type	Description
`field`	string	The key to retrieve.
`cb`	CIQ.NameValueStore~getCallback	Called with `(null, value)` on success or `(err)` on failure. Returns `null` for missing keys.

Since:

10.5.0

<static> NameValueStoreLarge#remove(field [, cb])

Removes a field from the store.

Parameters:

Name	Type	Argument	Description
`field`	string		The key to remove.
`cb`	CIQ.NameValueStore~updateCallback	<optional>	Called with `(null)` on success or `(err)` on failure.

Since:

10.5.0

<static> NameValueStoreLarge#set(field, value [, cb])

Stores a value in the store.

Parameters:

Name	Type	Argument	Description
`field`	string		The key under which the value is stored.
`value`	string \| object		The value to store.
`cb`	CIQ.NameValueStore~updateCallback	<optional>	Called with `(null)` on success or `(err)` on failure.

Since:

10.5.0