# @nikaple/mapped-types

> Create data classes easily

Latest version **1.0.3** (published 2024-01-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nikaple/mapped-types
pnpm add @nikaple/mapped-types
yarn add @nikaple/mapped-types
bun add @nikaple/mapped-types
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2024-01-08 |
| First published | 2023-12-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 23.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | nikaple |
| Maintainers | nikaple |

## Links

- npm: https://www.npmjs.com/package/@nikaple/mapped-types
- Repository: https://github.com/Nikaple/mapped-types
- Homepage: https://github.com/Nikaple/mapped-types#readme
- Issues: https://github.com/Nikaple/mapped-types/issues
- npm.io page: https://npm.io/package/@nikaple/mapped-types

## Recent versions

- 1.0.3 (latest) — 2024-01-08
- 1.0.2 — 2023-12-26
- 1.0.1 — 2023-12-26

## README

## Description

This is a fork of `mapped-types` from [Nest.js](https://github.com/nestjs/nest), but generalized to be used in other projects.

## Installation

```bash
$ npm i --save @nikaple/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, this project 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).

---
_Source: https://npm.io/package/@nikaple/mapped-types · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._