https://github.com/nestjs/mapped-types

Configuration module for Nest framework (node.js) 🐺
https://github.com/nestjs/mapped-types

javascript mapped-types nest nestjs nodejs typescript

Last synced: 1 day ago
JSON representation

Configuration module for Nest framework (node.js) 🐺

• Host: GitHub
• URL: https://github.com/nestjs/mapped-types
• Owner: nestjs
• License: mit
• Created: 2020-04-17T08:54:50.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T06:32:26.000Z (3 months ago)
• Last Synced: 2024-10-29T14:58:35.760Z (3 months ago)
• Topics: javascript, mapped-types, nest, nestjs, nodejs, typescript
• Language: TypeScript
• Homepage: https://nestjs.com
• Size: 4.6 MB
• Stars: 375
• Watchers: 7
• Forks: 58
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



[travis-image]: https://api.travis-ci.org/nestjs/nest.svg?branch=master

[travis-url]: https://travis-ci.org/nestjs/nest

[linux-image]: https://img.shields.io/travis/nestjs/nest/master.svg?label=linux

[linux-url]: https://travis-ci.org/nestjs/nest

  
A progressive Node.js framework for building efficient and scalable server-side applications.

    
















  

  



  


## Description

Mapped Types module for [Nest](https://github.com/nestjs/nest) used by the `@nestjs/graphql` and `@nestjs/swagger` packages.

## Installation

```bash

$ npm i --save @nestjs/mapped-types

```

## Quick Start

As you build out features, it's often useful to construct variants on a base entity type. A good example of such a variant is a **Data Transfer Object** (DTO). A Data Transfer Object is an object that is used to encapsulate data, and send it from one part of your application to another. DTO’s help us define the input and output interfaces of our system.

Let's imagine a real-world example, where we typically need to build both a **create** and **update** variations for the same entity type.

The create variant may require all fields, while the update variant may make all fields **optional**. Not to mention, both these types can also be variants of an entity type (to some extent).

That's a lot of redundant code!

Thus, [NestJS](https://github.com/nestjs/nest) now provides several utility functions that perform type transformations to help us avoid doing this, and make life a little bit easier.

Available mapped types:

- `PartialType` - returns a type (class) with all the properties of the input type set to optional (requirement: at least 1 validation decorator applied to each property)

- `PickType` - constructs a new type (class) by picking a set of properties from an input type

- `OmitType` - constructs a type by picking all properties from an input type and then removing a particular set of keys

- `IntersectionType` - combines two types into one new type (class)

Read more in [this article](https://trilon.io/blog/introducing-mapped-types-for-nestjs).

## Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).

## Stay in touch

- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)

- Website - [https://nestjs.com](https://nestjs.com/)

- Twitter - [@nestframework](https://twitter.com/nestframework)

## License

Nest is [MIT licensed](LICENSE).