Info

Serialization module for NestJS - Efficient - Flexible - Streamlined

Installation

1yarn install @iamnnort/nestjs-serializer

Usage

1
2// types.ts
3
4export enum Scopes {
5  BASE = 'BASE',
6  FULL = 'FULL',
7}
8
9// model.ts
10
11import { SerializeField } from '@iamnnort/nestjs-serializer';
12import { Scopes } from './types';
13
14export class Model {
15  @SerializeField([{ scopes: [Scopes.BASE] }])
16  id: number;
17
18  constructor(dto: { id: number }) {
19    this.id = dto.id;
20  }
21}
22
23// city.ts
24
25import { SerializeField } from '@iamnnort/nestjs-serializer';
26import { Model } from './model';
27import { Scopes } from './types';
28
29export class City extends Model {
30  @SerializeField([{ scopes: [Scopes.FULL] }])
31  name: string;
32
33  constructor(dto: { id: number; name: string }) {
34    super(dto);
35
36    this.name = dto.name;
37  }
38}
39
40// user.ts
41
42import { SerializeField, SerializeRelation } from '@iamnnort/nestjs-serializer';
43import { City } from './city';
44import { Model } from './model';
45import { Scopes } from './types';
46
47export class User extends Model {
48  @SerializeField([{ scopes: [Scopes.FULL] }])
49  name: string;
50
51  @SerializeRelation([{ scopes: [Scopes.FULL], relationScopes: [Scopes.BASE, Scopes.FULL] }])
52  city: City;
53
54  constructor(dto: { id: number; name: string; city: City }) {
55    super(dto);
56
57    this.name = dto.name;
58    this.city = dto.city;
59  }
60}
61
62// controller.ts
63
64import { Controller, Get, Post, UseInterceptors } from '@nestjs/common';
65import { SerializerIdInterceptor, SerializerInterceptor } from '@iamnnort/nestjs-serializer';
66import { User } from './user';
67import { Scopes } from './types';
68import { City } from './city';
69
70@Controller()
71export class AppController {
72  @Get()
73  @UseInterceptors(SerializerInterceptor({ scopes: [Scopes.BASE] }))
74  search() {
75    const city = new City({
76      id: 1,
77      name: 'London',
78    });
79
80    const user = new User({
81      id: 1,
82      name: 'John',
83      city,
84    });
85
86    return [user];
87  }
88
89  @Get(':id')
90  @UseInterceptors(SerializerInterceptor({ scopes: [Scopes.BASE, Scopes.FULL] }))
91  get() {
92    const city = new City({
93      id: 1,
94      name: 'London',
95    });
96
97    const user = new User({
98      id: 1,
99      name: 'John',
100      city,
101    });
102
103    return user;
104  }
105
106  @Post()
107  @UseInterceptors(SerializerIdInterceptor)
108  create() {
109    const city = new City({
110      id: 1,
111      name: 'London',
112    });
113
114    const user = new User({
115      id: 1,
116      name: 'John',
117      city,
118    });
119
120    return user;
121  }
122}
123
124// module.ts
125
126import { Module } from '@nestjs/common';
127import { LoggerModule } from '@iamnnort/nestjs-logger';
128import { SerializerModule } from '@iamnnort/nestjs-serializer';
129import { Model } from './model';
130import { AppController } from './controller';
131
132@Module({
133  imports: [
134    LoggerModule,
135    SerializerModule.register({
136      globalEntityNames: [Model.name],
137    }),
138  ],
139  controllers: [AppController],
140})
141export class AppModule {}
142
143// index.ts
144
145import { NestFactory } from '@nestjs/core';
146import { LoggerService } from '@iamnnort/nestjs-logger';
147import { AppModule } from './module';
148
149async function bootstrap() {
150  const app = await NestFactory.create(AppModule, {
151    bufferLogs: true,
152  });
153
154  app.useLogger(new LoggerService());
155
156  await app.listen(3000);
157}
158
159bootstrap();

Output

1[System] Application is starting...
2[System] Application started.
3[System] [Request] GET /
4[System] [Response] GET / 200 OK [{ id: 1 }]
5[System] [Request] GET /1
6[System] [Response] GET /1 200 OK [{ id: 1, name: "John", city: { id: 1, name: "London" } }]
7[System] [Request] POST /1
8[System] [Response] POST /1 201 Created { id: 1 }

License

This project is licensed under the MIT license. See the LICENSE file for more info.