https://github.com/kpfromer/nestjs-typegoose
Typegoose with NestJS
https://github.com/kpfromer/nestjs-typegoose
mongoose nest nestjs nestjs-typegoose typegoose typescript
Last synced: about 1 year ago
JSON representation
Typegoose with NestJS
- Host: GitHub
- URL: https://github.com/kpfromer/nestjs-typegoose
- Owner: kpfromer
- License: mit
- Created: 2018-04-16T01:55:53.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-05-08T08:12:14.000Z (about 1 year ago)
- Last Synced: 2025-05-12T23:12:13.952Z (about 1 year ago)
- Topics: mongoose, nest, nestjs, nestjs-typegoose, typegoose, typescript
- Language: TypeScript
- Homepage: https://kpfromer.github.io/nestjs-typegoose/
- Size: 5.46 MB
- Stars: 287
- Watchers: 7
- Forks: 73
- Open Issues: 115
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nestjs - Nest Typegoose - nest.js 的 [Typegoose](https://github.com/szokodiakos/typegoose) 模块。 (资源 / 集成)
README
# nestjs-typegoose
[](https://nodei.co/npm/nestjs-typegoose/)
[](https://badge.fury.io/js/nestjs-typegoose)
[](https://travis-ci.org/kpfromer/nestjs-typegoose)
[](https://coveralls.io/github/kpfromer/nestjs-typegoose?branch=master)
## Description
Injects [typegoose](https://github.com/szokodiakos/typegoose) models for [nest](https://github.com/nestjs/nest) components and controllers. Typegoose equivalant for [@nestjs/mongoose.](https://docs.nestjs.com/techniques/mongodb)
Using Typegoose removes the need for having a Model interface.
## Installation
```bash
npm install --save nestjs-typegoose
```
or
```
yarn add nestjs-typegoose
```
## Documentation
[Here is the full documentation describing all basic and advanced features.](https://kpfromer.github.io/nestjs-typegoose/)
## Basic usage
You can checkout the `example` project for more details.
**app.module.ts**
```typescript
import { Module } from "@nestjs/common";
import { TypegooseModule } from "nestjs-typegoose";
import { CatsModule } from "./cat.module.ts";
@Module({
imports: [
TypegooseModule.forRoot("mongodb://localhost:27017/nest", {
useNewUrlParser: true,
}),
CatsModule,
],
})
export class ApplicationModule {}
```
Create class that describes your schema
**cat.model.ts**
```typescript
import { prop } from "@typegoose/typegoose";
import { IsString } from "class-validator";
export class Cat {
@IsString()
@prop({ required: true })
name: string;
}
```
Inject Cat for `CatsModule`
**cat.module.ts**
```typescript
import { Module } from "@nestjs/common";
import { TypegooseModule } from "nestjs-typegoose";
import { Cat } from "./cat.model";
import { CatsController } from "./cats.controller";
import { CatsService } from "./cats.service";
@Module({
imports: [TypegooseModule.forFeature([Cat])],
controllers: [CatsController],
providers: [CatsService],
})
export class CatsModule {}
```
Get the cat model in a service
**cats.service.ts**
```typescript
import { Injectable } from "@nestjs/common";
import { InjectModel } from "nestjs-typegoose";
import { Cat } from "./cat.model";
import { ReturnModelType } from "@typegoose/typegoose";
@Injectable()
export class CatsService {
constructor(
@InjectModel(Cat) private readonly catModel: ReturnModelType
) {}
async create(createCatDto: { name: string }): Promise {
const createdCat = new this.catModel(createCatDto);
return await createdCat.save();
}
async findAll(): Promise {
return await this.catModel.find().exec();
}
}
```
Finally, use the service in a controller!
**cats.controller.ts**
```typescript
import { Controller, Get, Post, Body } from "@nestjs/common";
import { CatsService } from "./cats.service";
import { Cat } from "./cats.model.ts";
@Controller("cats")
export class CatsController {
constructor(private readonly catsService: CatsService) {}
@Get()
async getCats(): Promise {
return await this.catsService.findAll();
}
@Post()
async create(@Body() cat: Cat): Promise {
return await this.catsService.create(cat);
}
}
```
## Requirements
1. @typegoose/typegoose +6.1.5
2. @nestjs/common +6.10.1
3. @nestjs/core +6.10.1
4. mongoose (with typings `@types/mongoose`) +5.7.12
## License
nestjs-typegoose is [MIT licensed](LICENSE).