Class Hive
In memory store for Node JS.
Defined in: hive.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Hive()
|
Method Attributes | Method Name and Description |
---|---|
append(key, value)
Appends a value to a current value, if the current value is a string, and the appending
value is a string then it will be appeneded to the value otherwise an array is created to
store both values.
|
|
decr(key)
Decrements a value, if it is numeric.
|
|
flushAll()
Remove all values from the store.
|
|
get(key)
Retrive the value for a specified key
|
|
getKeyGt(key)
Retrives all values with a greater than the provided key.
|
|
getKeyGte(key)
Retrives all values with a greater or equal to than the provided key.
|
|
getKeyLt(key)
Retrives all values with a key less than the provided key.
|
|
getKeyLte(key)
Retrives all values with a key less or equal to a than the provided key.
|
|
incr(key)
Increments a value, if it is numeric.
|
|
kill()
Kills the clean up process for looking for expired keys.
|
|
prepend(key, value)
Prepends a value to a current value, if the current value is a string, and the prepedning
value is a string then it will be prepeneded to the value otherwise an array is created to
store both values.
|
|
remove(key)
Remove a value from this store.
|
|
replace(key, value, expires)
Replace a key value pair in this Store.
|
|
set(key, value, expires)
Set a key value pair.
|
Method Detail
append(key, value)
Appends a value to a current value, if the current value is a string, and the appending
value is a string then it will be appeneded to the value otherwise an array is created to
store both values.
- Parameters:
- {*} key
- the key to look up.
- {*} value
- the value to append
decr(key)
Decrements a value, if it is numeric.
- Parameters:
- {*} key
- the key to look up the value to decrement.
flushAll()
Remove all values from the store.
get(key)
Retrive the value for a specified key
- Parameters:
- {*} key
- the key to look up. * @return {*} the value or null if not found.
{Array}
getKeyGt(key)
Retrives all values with a greater than the provided key.
- Parameters:
- {*} key
- the key to look up.
- Returns:
- {Array} an array of values.
{Array}
getKeyGte(key)
Retrives all values with a greater or equal to than the provided key.
- Parameters:
- {*} key
- the key to look up.
- Returns:
- {Array} an array of values.
{Array}
getKeyLt(key)
Retrives all values with a key less than the provided key.
- Parameters:
- {*} key
- the key to look up.
- Returns:
- {Array} an array of values.
{Array}
getKeyLte(key)
Retrives all values with a key less or equal to a than the provided key.
- Parameters:
- {*} key
- the key to look up.
- Returns:
- {Array} an array of values.
incr(key)
Increments a value, if it is numeric.
- Parameters:
- {*} key
- the key to look up the value to increment.
kill()
Kills the clean up process for looking for expired keys.
prepend(key, value)
Prepends a value to a current value, if the current value is a string, and the prepedning
value is a string then it will be prepeneded to the value otherwise an array is created to
store both values.
- Parameters:
- {*} key
- the key to look up.
- {*} value
- the value to prepend
remove(key)
Remove a value from this store.
- Parameters:
- {*} key
- the key of the key value pair to remove.
{*}
replace(key, value, expires)
Replace a key value pair in this Store.
- Parameters:
- {*} key
- the key to store
- {*} value
- the value to asociate with the key.
- {Number} expires Optional, Default: Infinity
- if provided sets a max life on a key, value pair.
- Returns:
- {*} the value
set(key, value, expires)
Set a key value pair.
- Parameters:
- {*} key
- the key to store
- {*} value
- the value to asociate with the key.
- {Number} expires Optional, Default: Infinity
- if provided sets a max life on a key, value pair. * @return {*} the value