@nestjs/mapped-types

What is @nestjs/mapped-types?

The @nestjs/mapped-types package is a utility module for NestJS, which provides functions to transform and map types. It is commonly used to create DTOs (Data Transfer Objects) by inheriting validation rules without the need to redefine them, thus reducing redundancy and potential for errors.

What are @nestjs/mapped-types's main functionalities?

PartialType

Creates a type (class) with all the properties of the input type set to optional. Useful for update operations where only a subset of properties may be provided.

{"@nestjs/swagger": "^5.0.0", "@nestjs/mapped-types": "^0.4.0"}

PickType

Creates a type by picking a set of properties from an existing type. This is useful when you want to expose only certain fields of a model for a particular use case.

{"@nestjs/swagger": "^5.0.0", "@nestjs/mapped-types": "^0.4.0"}

OmitType

Creates a type by omitting a set of properties from an existing type. This can be used to exclude sensitive information or irrelevant properties from being exposed.

{"@nestjs/swagger": "^5.0.0", "@nestjs/mapped-types": "^0.4.0"}

IntersectionType

Combines two types into one new type (class) that includes all properties from both types. This is useful for combining properties from multiple sources or adding additional properties to an existing type.

{"@nestjs/swagger": "^5.0.0", "@nestjs/mapped-types": "^0.4.0"}

Other packages similar to @nestjs/mapped-types

class-transformer

This package is similar to @nestjs/mapped-types in that it allows the transformation of objects to classes and vice versa. It also provides decorators to control the transformation behavior. However, it does not focus on creating mapped types but rather on the transformation process itself.

class-validator

While not directly similar to @nestjs/mapped-types, class-validator works well in conjunction with it by providing decorators to add validation rules to class properties. It is often used together with class-transformer to validate and transform data in NestJS applications.

type-fest

Type-fest is a TypeScript utility library that provides a collection of essential types for everyday use. It includes types similar to those in @nestjs/mapped-types, such as PartialDeep, RequiredDeep, etc. However, it is not specifically tailored to NestJS and does not integrate with the framework's features like @nestjs/mapped-types does.