nestjs-type-mongodb's Introduction

nestjs-type-mongodb

Installation

$ yarn add nestjs-type-mongodb

Basic usage

app.module.ts

import { Module } from "@nestjs/common";
import { TypeMongoDBModule } from 'nestjs-type-mongodb';
import { DogsModule } from "./dog.module.ts";

@Module({
  imports: [
    TypeMongoDBModule.forRoot({
      connection: {
        uri: 'mongodb://localhost:31000/animals?replicaSet=test',
        database: 'animals'
      }
    }),
    DogsModule
  ]
})
export class AppModule {}

Create class that describes your schema

dog.model.ts

import { Document, Id, Field } from 'type-mongodb';
import { ObjectId } from 'mongodb';

@Document()
export class Dog {
  @Id()
  _id: ObjectId;

  @Field()
  name: string;

  @Field()
  age: number;

  @Field()
  breed: string;
}

Inject Dog for DogsModule

dog.module.ts

import { Module } from '@nestjs/common';
import { TypeMongoDBModule } from 'nestjs-type-mongodb';
import { DogsController } from './dogs.controller';
import { DogsService } from './dogs.service';
import { Dog } from './models/dog';

@Module({
    imports: [
        TypeMongoDBModule.forFeature([Dog])
    ],
    controllers: [DogsController],
    providers: [DogsService]
})
export class DogsModule { }

Get the dog repository in a service

dogs.service.ts

import { Injectable } from '@nestjs/common';
import { InjectRepository } from 'nestjs-type-mongodb';
import { Repository } from 'type-mongodb';
import { CreateDogDto } from './dto/create-dog.dto';
import { Dog } from './models/dog';

@Injectable()
export class DogsService {
    constructor(
        @InjectRepository(Dog)
        private readonly repository: Repository<Dog>
    ) { }

    async create(dog: CreateDogDto): Promise<Dog> {
        return this.repository.create(dog);
    }

    async findAll(): Promise<Dog[]> {
        return this.repository.find().toArray();
    }
}