nest-ottoman v1.2.0

Nestjs Ottoman

Ottoman module for Nestjs

Features

• Model support
• Simply add @InjectModel(ModelName) to your service and you are ready to go

Installation

Yarn

yarn add nest-ottoman ottoman

NPM

npm install nest-ottoman ottoman --save

PNPM

pnpm add nest-ottoman ottoman

Usage

Module Registration

import { Module } from '@nestjs/common';
import { OttomanModule } from 'nest-ottoman';

@Module({
  imports: [
    OttomanModule.forRoot({
      connectionString: 'couchbase://localhost',
    }),
  ],
})

export class AppModule {}

Async registration is also available:

import { Module } from '@nestjs/common';
import { OttomanModule } from 'nest-ottoman';

@Module({
  imports: [
    OttomanModule.forRootAsync({
      useFactory: () => ({
        connectionString: 'couchbase://localhost',
      }),
    }),
  ],
})

export class AppModule {}

Model Registration

@Property decorator is ottoman property decorator. More information about decorators can be found here

import { Model, Property } from 'nest-ottoman';

@Model('_default')
export class DefaultModel {
  @Property()
  id: string;

  @Property()
  property: string;
}

Service Registration

import { Injectable } from '@nestjs/common';
import { DefaultModel } from './collections/foo.collection';
import { Model, InjectModel } from 'nest-ottoman';

@Injectable()
export class AppService {
  constructor(
    @InjectModel(DefaultModel)
    private readonly defaultModel: Model<DefaultModel>,
  ) {}
  
  findAll(): Promise<DefaultModel[]> {
    return this.defaultModel.find();
  }
}

Decorators

Nest Ottoman Module Options

Example Application

Example application can be found here