1 Star 0 Fork 1

鸿则 / nest-nedb

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
README.md 4.28 KB
一键复制 编辑 原始数据 按行查看 历史
鸿则 提交于 2019-08-20 19:22 . doc: add quick start to readme.md

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

NPM Version Package License NPM Downloads Travis Linux Coverage Discord Backers on Open Collective Sponsors on Open Collective

Description

The NEDB module for Nest.

Installation

$ npm i --save @hungtcs-box/nest-nedb nedb
$ npm i --save-dev @types/nedb

Quick Start

  1. First in your model file, extends the base Model
import { Model } from '@hungtcs-box/nest-nedb';

export class UserModel extends Model {
  username?: string;

}
  1. Import NedbModule.forFeature in your UsersModule
import { UserModel } from './models/user.model';
import { NedbModule } from '@hungtcs-box/nest-nedb';

@Module({
  imports: [
    PasswdModule,
    NedbModule.forFeature([
      {
        model: UserModel,
        indexes: {
          username: {
            unique: true,
          },
        },
      },
    ]),
  ],
  exports: [
    UsersService,
  ],
  providers: [
    UsersService,
  ],
  controllers: [
    UsersController,
  ],
})
export class UsersModule {

}
  1. Import NedbModule.forRoot in your AppModule
import { NedbModule } from '@hungtcs-box/nest-nedb';

@Module({
  imports: [
    NedbModule.forRoot(`path/to/your/database/file`),
  ],
  controllers: [
    AppController,
  ],
})
export class AppModule {

}
  1. Now you can inject the nedb DataStore in your UserService
@Injectable()
export class UsersService {

  constructor(
      @InjectDatastore(UserModel) private readonly dataStore: DataStore<UserModel>) {

  }

}

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest and Nedb is MIT licensed.

TypeScript
1
https://gitee.com/hungtcs/nest-nedb.git
git@gitee.com:hungtcs/nest-nedb.git
hungtcs
nest-nedb
nest-nedb
master

搜索帮助