https://github.com/nest-dynamodb/typedorm
A DynamoDB module for Nest framework (node.js) using typeDorm library
https://github.com/nest-dynamodb/typedorm
aws dynamodb nestjs typedorm
Last synced: 4 months ago
JSON representation
A DynamoDB module for Nest framework (node.js) using typeDorm library
- Host: GitHub
- URL: https://github.com/nest-dynamodb/typedorm
- Owner: nest-dynamodb
- License: mit
- Created: 2023-02-23T05:48:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-03-03T20:59:31.000Z (4 months ago)
- Last Synced: 2026-03-03T21:13:45.465Z (4 months ago)
- Topics: aws, dynamodb, nestjs, typedorm
- Language: TypeScript
- Homepage:
- Size: 206 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A DynamoDB module for Nest framework (node.js) using typeDorm library
### Installation
#### with npm
```sh
npm install --save @nest-dynamodb/typedorm
```
#### with yarn
```sh
yarn add @nest-dynamodb/typedorm
```
### How to use?
#### TypeDormModule.forRoot(options)
```ts
import { Module } from '@nestjs/common';
import { TypeDormModule } from '@nest-dynamodb/typedorm';
import { AppController } from './app.controller';
@Module({
imports: [
TypeDormModule.forRoot({
table,
entities: [],
documentClient: new DocumentClientV3(new DynamoDBClient({})),
name: instanceName
}),
],
controllers: [AppController],
})
export class AppModule {}
```
#### TypeDormModule.forRootAsync(options)
```ts
import { Module } from '@nestjs/common';
import { TypeDormModule } from '@nest-dynamodb/typedorm';
import { AppController } from './app.controller';
@Module({
imports: [
TypeDormModule.forRootAsync({
// need another name here for dependency injection, @InjectTypeDorm(instanceName)
name: instanceName,
useFactory: async () => {
return {
table,
entities: [],
documentClient: new DocumentClientV3(new DynamoDBClient({})),
name: instanceName
}
},
}),
],
controllers: [AppController],
})
export class AppModule {}
```
#### InjectTypeDorm(name?)
```ts
import { Controller, Get, } from '@nestjs/common';
import { InjectTypeDorm, TypeDormConnection } from '@nest-dynamodb/typedorm';
@Controller()
export class AppController {
constructor(
@InjectTypeDorm() private readonly connection: TypeDormConnection,
) {}
@Get()
async getHello() {
const item = await this.connection.entityManager.findOne(...);
return { item };
}
}
```
#### TypeDormModule.forRootNonInjection(options)
```ts
import { Module } from '@nestjs/common';
import { TypeDormModule } from '@nest-dynamodb/typedorm';
import { AppController } from './app.controller';
@Module({
imports: [
TypeDormModule.forRootNonInjection({
table,
entities: [],
documentClient: new DocumentClientV3(new DynamoDBClient({})),
}),
],
controllers: [AppController],
})
export class AppModule {}
```
```ts
import { Controller, Get, } from '@nestjs/common';
import { TypeDormConnection } from '@nest-dynamodb/typedorm';
@Controller()
export class AppController {
constructor(
// do not need InjectTypeDorm here
private readonly connection: TypeDormConnection,
) {}
@Get()
async getHello() {
const item = await this.connection.entityManager.findOne(...);
return { item };
}
}
```
## License
MIT