@nestjs-mod/keyv
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

@nestjs-mod/keyv

Simple key-value storage with support for multiple backends, and a consistent interface for NestJS-mod (Wrapper for https://www.npmjs.com/package/keyv)

NPM version monthly downloads Telegram Discord

Installation

npm i --save keyv@5.2.3 @nestjs-mod/keyv

Modules

Link Category Description
KeyvModule core Simple key-value storage with support for multiple backends, and a consistent interface for NestJS-mod (Wrapper for https://www.npmjs.com/package/keyv)

Modules descriptions

KeyvModule

Simple key-value storage with support for multiple backends, and a consistent interface for NestJS-mod (Wrapper for https://www.npmjs.com/package/keyv)

Shared providers

KeyvService

Environments

Key Description Sources Constraints Default Value
url Connection string for store data (example: redis://:redis_password@localhost:6379) obj['url'], process.env['KEYV_URL'] optional - -

Static configuration

Key Description Constraints Default Value
defaultLogger Default logger optional - -
featureName Feature name for generate prefix to environments keys optional - -
emitErrors Emit errors. optional true -
namespace Namespace for the current instance. optional - -
serialize A custom serialization function. optional default -
deserialize A custom deserialization function. optional default -
store The storage adapter instance to be used by Keyv. optional - -
storeFactoryByEnvironmentUrl Function for create storage adapter instance to be used by Keyv by environment url. optional - -
ttl Default TTL. Can be overridden by specifying a TTL on .set(). optional - -
compression Enable compression option. optional - -
stats Enable or disable statistics (default is false) optional false -
useKeyPrefix Enable or disable key prefixing (default is true) optional true -

Back to Top

Links

License

MIT

Package Sidebar

Install

npm i @nestjs-mod/keyv

Weekly Downloads

98

Version

1.1.1

License

MIT

Unpacked Size

39.1 kB

Total Files

27

Last publish

Collaborators

  • endykaufman