open-index/open-npm huggingface dataset:
npm package: @iot9x.com/nestjs-redis
Description: nestjs redis驱动
Author: Iric
Latest version: 3.0.2

# NestJS Redis 插件

注意：<font color="#dd0000">仍在开发中，目前仅在内部使用</font><br />

[文档地址](https://docs.iot9x.com/docs/nestjs/Redis/)

## 支持环境

* node >=`16.x`
* NestJS >= `8.x`

|版本|对应nestjs版本|开发时NodeJS版本|
|-----|-----|
| `v3.x` | `v10.x` | `v20.10.0` |
| `v2.x` | `v9.x` | `v16.18.0` |
| `v1.x` | `v8.x` ||

## 安装

```shell
$ npm i @iot9x.com/nestjs-redis

or
$ yarn add @iot9x.com/nestjs-redis

or
$ pnpm add @iot9x.com/nestjs-redis  # 推荐使用pnpm
```

### 使用

详见文档：[NestJS Redis 驱动](https://docs.iot9x.com/docs/nestjs/Redis/)
npm package: @iot9x.com/nestjs-swagger
Description: nestjs swagger增强版
Author: Iric
Latest version: 1.0.2

# NestJS Swagger 插件增强版

注意：<font color="#dd0000">仍在开发中，目前仅在内部使用</font><br /> 

[文档地址](https://docs.iot9x.com/nestjs/8/swagger/)

## 使用说明

外部人员**仅供参考**，请不要用于生产环境，因此导致的事故后果请自行承担。

## 环境

基于[@nestjs/swagger](https://github.com/nestjs/swagger) v6.1.2

* node >=`16.x`
* nest >=`9.x`

## 安装

```bash
$ npm i @iot9x.com/nestjs-swagger
or
$ yarn add @iot9x.com/nestjs-swagger
or
$ pnpm add @iot9x.com/nestjs-swagger  # 推荐使用pnpm
```

## 配置

装饰器模式与原版功能一致，但是 `plugin` 模式有修改增强。

```json
{
  "collection": "@nestjs/schematics",
  "sourceRoot": "src",
  "compilerOptions": {
    "plugins": [
      {
        "name": "@iot9x.com/nestjs-swagger",
        "options": {
          "dtoFileNameSuffix": [
            ".dto.ts"
          ],
          "controllerFileNameSuffix": ".controller.ts",
          "classValidatorShim": true,
          "introspectComments": true
        }
      }
    ]
  }
}
```

option配置：

```ts
export interface PluginOptions {
  dtoFileNameSuffix?: string | string[];
  controllerFileNameSuffix?: string | string[];
  classValidatorShim?: boolean;
  dtoKeyOfComment?: string;
  controllerKeyOfComment?: 'summary' | 'description';
  introspectComments?: boolean;
}
```

|配置项|默认值|说明|
|-----|-----|-----|
| `dtoFileNameSuffix` | `['.dto.ts', '.entity.ts']` |与原版相同|
| `controllerFileNameSuffix` | `.controller.ts` |与原版相同|
| `classValidatorShim` | `true` |与原版相同|
| `dtoKeyOfComment` | `'description'` |与原版相同|
| `controllerKeyOfComment` | `'description'` |选择 `'description'` 的时候与原版相同，选择 `'summary'` 的时候是魔改增强版本，支持注释中的 `@description` 功能|
| `introspectComments` | `false` |与原版相同|

## RoadMap

* [√] 支持`Controller`中方法注释的`@return`注释描述。
* [ ] 支持`ResDTO`泛型类型。
* [ ] 支持`interface`类型参数的`DTO`解析。
npm package: @iot9x.com/nestjs-tdengine-restful
Description: NestJS TDengine 驱动——基于Restful
Author: Iric
Latest version: 0.0.6

# NestJS `TDengine` 驱动插件

注意：<font color="#dd0000">仍在开发中，目前仅在内部使用</font><br /> 

## 使用说明

外部人员仅供参考，请不要用于生产环境，因此导致的事故后果请自行承担。

### 支持环境

* node >=`14.x`
* NestJS === `8.x`

### 安装

```shell
$ npm i @iot9x.com/nestjs-tdengine-restful

or
$ yarn add @iot9x.com/nestjs-tdengine-restful  # 推荐使用yarn
```

### 配置

#### 同步方式

```typescript
import { Module } from '@nestjs/common';
import { TDengineModule } from '@iot9x.com/nestjs-tdengine-restful'

@Module({
  imports: [
    TDengineModule.forRoot({
      url: 'http://127.0.0.1:6041',
      username: 'root',
      password: 'taosdata',
      logging: false
    }),
  ]
})
export class AppModule { }
```

#### 异步方式

```typescript
import { Module } from '@nestjs/common';
import { ConfigModule, ConfigType } from '@nestjs/config';
import { TDengineModule } from '@iot9x.com/nestjs-tdengine-restful'
import { TDengineConfigRegister } from './modules/config/registers/tdengine.register';
import { ConfigValidation } from './modules/config/validations/config.validation';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      validationSchema: ConfigValidation,
      validationOptions: {
        allowUnknown: true,
        abortEarly: true
      },
      load: [TDengineConfigRegister]
    }),
    TDengineModule.forRootAsync({
      useFactory: (tdengineConfig: ConfigType<typeof TDengineConfigRegister>) => tdengineConfig,
      inject: [TDengineConfigRegister.KEY]
    })
  ]
})
export class AppModule {}
```

## 文档地址

* [私有Gitlab](https://gitlab.lantsang.cn/nestjs-plugins-star/nestjs-tdengine-restful/tree/master/docs)
* [GitHub](https://github.com/iot9x.com/nestjs-tdengine-restful/tree/master/docs)
* [Gitee](https://gitee.com/iot9x.com/nestjs-tdengine-restful/tree/master/docs)