https://github.com/nestjsplus/ioredis

Configurable ioRedis Module for NestJs
https://github.com/nestjsplus/ioredis

Last synced: about 2 months ago
JSON representation

Configurable ioRedis Module for NestJs

• Host: GitHub
• URL: https://github.com/nestjsplus/ioredis
• Owner: nestjsplus
• License: mit
• Created: 2019-08-03T19:46:34.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T06:13:03.000Z (almost 2 years ago)
• Last Synced: 2024-10-23T04:43:15.130Z (2 months ago)
• Language: TypeScript
• Size: 774 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Configurable ioredis module for NestJS




  

    

  

  

    

  



## Documentation

```typescript

DEFAULT_REDIS_OPTIONS = {

    // Connection

    port: 6379,

    host: 'localhost',

    family: 4,

    connectTimeout: 10000,

    retryStrategy: function (times) {

        return Math.min(times * 50, 2000);

    },

    keepAlive: 0,

    noDelay: true,

    connectionName: null,

    // Sentinel

    sentinels: null,

    name: null,

    role: 'master',

    sentinelRetryStrategy: function (times) {

        return Math.min(times * 10, 1000);

    },

    natMap: null,

    enableTLSForSentinelMode: false,

    updateSentinels: true,

    // Status

    password: null,

    db: 0,

    // Others

    dropBufferSupport: false,

    enableOfflineQueue: true,

    enableReadyCheck: true,

    autoResubscribe: true,

    autoResendUnfulfilledCommands: true,

    lazyConnect: false,

    keyPrefix: '',

    reconnectOnError: null,

    readOnly: false,

    stringNumbers: false,

    maxRetriesPerRequest: 20,

    maxLoadingRetryTime: 10000

};

```

## Change Log

See [Changelog](CHANGELOG.md) for more information.

## Contributing

Contributions welcome! See [Contributing](CONTRIBUTING.md).

## Author

* **John Biundo (Y Prospect on [Discord](https://discord.gg/G7Qnnhy))**

## License

Licensed under the MIT License - see the [LICENSE](LICENSE) file for details.