## Rejson **Kind**: global class * [Rejson](#Rejson) * [new Rejson()](#new_Rejson_new) * _instance_ * [.connect()](#Rejson+connect) ⇒ Promise * [.set(key, path, value)](#Rejson+set) ⇒ Promise * [.get(key, path)](#Rejson+get) ⇒ Promise * [.mget(...key, path)](#Rejson+mget) ⇒ Promise * [.del(key, path)](#Rejson+del) ⇒ Promise * [.objkeys(key, path)](#Rejson+objkeys) ⇒ Promise * _static_ * [.defaultOptions](#Rejson.defaultOptions) : Object * [.commands](#Rejson.commands) : Array ### new Rejson() Creates a Rejson instance ### rejson.connect() ⇒ Promise Connect **Kind**: instance method of [Rejson](#Rejson) ### rejson.set(key, path, value) ⇒ Promise Set a JSON value [JSON.SET](https://redislabsmodules.github.io/rejson/commands/#jsonset) **Kind**: instance method of [Rejson](#Rejson) **Returns**: Promise - - A promise that will resolve to true when value is set **Access**: public | Param | Type | Description | | --- | --- | --- | | key | string | The key of the value | | path | string | The path of the value | | value | object | The value to set | ### rejson.get(key, path) ⇒ Promise Get a JSON value [JSON.GET](https://redislabsmodules.github.io/rejson/commands/#jsonget) **Kind**: instance method of [Rejson](#Rejson) **Returns**: Promise - - A promise that will resolve to the JSON object at key path, or null if not found **Access**: public | Param | Type | Description | | --- | --- | --- | | key | string | The key of the value | | path | string | The path of the value | ### rejson.mget(...key, path) ⇒ Promise Get multiple JSON values at the same time (for a given path) **Kind**: instance method of [Rejson](#Rejson) **Returns**: Promise - - A promise that will resolve to an array of the JSON objects found at key paths **Access**: public | Param | Type | Description | | --- | --- | --- | | ...key | string | The key to get value for | | path | string | The path of the value | ### rejson.del(key, path) ⇒ Promise Delete a JSON value (or value at a specific path) **Kind**: instance method of [Rejson](#Rejson) **Returns**: Promise - - A promise that will resolve to true when value is deleted **Access**: public | Param | Type | Description | | --- | --- | --- | | key | string | The key of the value | | path | string | The path of the value | ### rejson.objkeys(key, path) ⇒ Promise Get the object keys for a JSON value (for a given path) **Kind**: instance method of [Rejson](#Rejson) **Returns**: Promise - - A promise that will resolve to array of keys at path **Access**: public | Param | Type | Description | | --- | --- | --- | | key | string | The key of the value | | path | string | The path of the value | ### Rejson.defaultOptions : Object Default options **Kind**: static property of [Rejson](#Rejson) ### Rejson.commands : Array Commands **Kind**: static property of [Rejson](#Rejson)