v7.0.0-alpha.1

7.0.0-alpha.1 - 2022-03-09

BREAKING CHANGES ⚠️

• refactor health checks

v6.0.0

6.0.0 - 2022-02-20

BREAKING CHANGES ⚠️

• remove exports for RedisStatus and ClusterStatus, those should be used internally (#189) (531af15)

• change default namespace from Symbol('default') to 'default' for best readability of the logs. Please note that you shouldn't have multiple client without a namespace, or with the same namespace, otherwise they will get overridden. (#189) (3849b48)

export const DEFAULT_REDIS_NAMESPACE = 'default'; // redis
export const DEFAULT_CLUSTER_NAMESPACE = 'default'; // cluster

Fixed

• use correct approach instead of instanceof to prevent some bugs in realms environment (#189) (08d7ede)

Added

• add isGlobal option as the second param to control whether the module is global-scoped and set its default value to true (#189) (617d204)

// redis
static forRoot(options: RedisModuleOptions = {}, isGlobal = true): DynamicModule;
static forRootAsync(options: RedisModuleAsyncOptions, isGlobal = true): DynamicModule;

// cluster
static forRoot(options: ClusterModuleOptions, isGlobal = true): DynamicModule;
static forRootAsync(options: ClusterModuleAsyncOptions, isGlobal = true): DynamicModule;

Security

• update npm dependencies

Changed

• update project config: ci, template, eslint, package, docker-compose.yml, etc
• update code comments for checkHealth
• extract common utils
• update messages for health
• update unit tests and e2e tests
• docs: add v5 docs, update README.md, update redis, cluster, health

v5.2.0

5.2.0 - 2021-12-10

Added

• add RedisService, this is an alias for RedisManager
• add ClusterService, this is an alias for ClusterManager

Changed

• simplify quitClients logic, remove unnecessary async/await
• update dependencies
• update 01-testing-inject
• update docs
• update tests

v5.1.1

5.1.1 - 2021-11-19

From version 5.1.1, the release information follows the keep a changelog format to maintain a human readable changelog.

Fixed

• fix missing PromiseSettledResult, use polyfill instead of it
• fix jest does not exit

Changed

• change nodejs version from 16 to 14
• change es version from es2021 to es2017
• update dependencies
• update hooks
• update docs

v5.1.0

What's Changed

New

• support nestjs 7.x

Maintenance

• update docs
• update ci

v5.0.1

What's Changed

Maintenance

• update comments (#132)
• update docs
• update dependencies

v5.0.0

What's Changed

⚠️ BREAKING CHANGES

• The default redis client will not be created if you do not specify the config option.

Migration from v4 to v5

If your redis server does not have a password, the host is 127.0.0.1 and the port is 6379:

v4

The default redis client will be created if you do not specify the config option:

import { Module } from '@nestjs/common';
import { RedisModule } from '@liaoliaots/nestjs-redis';

@Module({
    imports: [RedisModule.forRoot()]
})
export class AppModule {}

v5

The default redis client will not be created if you do not specify the config option, so you have to specify the config option:

import { Module } from '@nestjs/common';
import { RedisModule } from '@liaoliaots/nestjs-redis';

@Module({
    imports: [RedisModule.forRoot({ closeClient: true, config: { host: '127.0.0.1', port: 6379 } })]
})
export class AppModule {}

Documentation

• update readme menu
• update examples
• update redis

v4.1.3

What's Changed

Improvements

• refactor quit clients

Maintenance

• add global e2e test
• remove combination e2e test
• update README.md
• update ISSUE_TEMPLATE
• update dependencies

v4.1.2

What's Changed

Bug Fixes

• set default options correctly for useFactory (#129)
• add missing redis status monitoring (#129)

v4.1.1

What's Changed

Bug Fixes

• default config option to object (#128)