A DynamoDB module for Nest framework (node.js) using typeDorm library

Installation

with npm

1npm install --save @nest-dynamodb/typedorm

with yarn

1yarn add @nest-dynamodb/typedorm

How to use?

TypeDormModule.forRoot(options)

1import { Module } from '@nestjs/common';
2import { TypeDormModule } from '@nest-dynamodb/typedorm';
3import { AppController } from './app.controller';
4@Module({
5  imports: [
6    TypeDormModule.forRoot({
7        table,
8        entities: [],
9        documentClient: new DocumentClientV3(new DynamoDBClient({})),
10        name: instanceName
11      }),
12  ],
13  controllers: [AppController],
14})
15export class AppModule {}

TypeDormModule.forRootAsync(options)

1import { Module } from '@nestjs/common';
2import { TypeDormModule } from '@nest-dynamodb/typedorm';
3import { AppController } from './app.controller';
4@Module({
5  imports: [
6    TypeDormModule.forRootAsync({
7        // need another name here for dependency injection, @InjectTypeDorm(instanceName)
8        name: instanceName,
9        useFactory: async () => {
10          return {
11            table,
12            entities: [],
13            documentClient: new DocumentClientV3(new DynamoDBClient({})),
14            name: instanceName
15          }
16        },
17      }),
18  ],
19  controllers: [AppController],
20})
21export class AppModule {}

InjectTypeDorm(name?)

1import { Controller, Get, } from '@nestjs/common';
2import { InjectTypeDorm, TypeDormConnection } from '@nest-dynamodb/typedorm';
3@Controller()
4export class AppController {
5  constructor(
6    @InjectTypeDorm() private readonly connection: TypeDormConnection,
7  ) {}
8  @Get()
9  async getHello() {
10    const item = await this.connection.entityManager.findOne(...);
11    return { item };
12  }
13}

TypeDormModule.forRootNonInjection(options)

1import { Module } from '@nestjs/common';
2import { TypeDormModule } from '@nest-dynamodb/typedorm';
3import { AppController } from './app.controller';
4@Module({
5  imports: [
6    TypeDormModule.forRootNonInjection({
7        table,
8        entities: [],
9        documentClient: new DocumentClientV3(new DynamoDBClient({})),
10      }),
11  ],
12  controllers: [AppController],
13})
14export class AppModule {}

1import { Controller, Get, } from '@nestjs/common';
2import { TypeDormConnection } from '@nest-dynamodb/typedorm';
3@Controller()
4export class AppController {
5  constructor(
6    // do not need InjectTypeDorm here
7    private readonly connection: TypeDormConnection,
8  ) {}
9  @Get()
10  async getHello() {
11    const item = await this.connection.entityManager.findOne(...);
12    return { item };
13  }
14}

License

MIT