Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/airtoxin/chimney-ts
Type safe object transformation in TypeScript
https://github.com/airtoxin/chimney-ts
Last synced: about 9 hours ago
JSON representation
Type safe object transformation in TypeScript
- Host: GitHub
- URL: https://github.com/airtoxin/chimney-ts
- Owner: airtoxin
- License: mit
- Created: 2019-11-06T23:12:49.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T17:14:57.000Z (over 1 year ago)
- Last Synced: 2024-10-12T09:07:55.477Z (25 days ago)
- Language: TypeScript
- Homepage:
- Size: 3.13 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# Chimney-ts
[](https://travis-ci.org/airtoxin/chimney-ts)
[](https://paypal.me/airtoxin)
Type safe object transformation in TypeScript.
This project was heavily inspired from https://github.com/scalalandio/chimney
## Usage
```typescript
import { Chimney } from "chimney-ts";
const square = { size: 10 };
type Rect = { width: number, height: number };
const incompleteRect = new Chimney(square)
.into()
.withFieldRenamed("size", "width");
// Can't call `transform()` because `height` property not filled
// incompleteRect.transform()
const completeRect = incompleteRect
.withFieldRenamed("size", "height")
.transform();
// Square transforms into Rect
```
Also transforms from Array or Promise
```typescript
new Chimney([square])
.into()
.withFieldRenamed("size", "width")
.withFieldRenamed("size", "height")
.transform(); // -> Rect[]
new Chimney(Promise.resolve(square))
.into()
.withFieldRenamed("size", "width")
.withFieldRenamed("size", "height")
.transform(); // -> Promise
```
## API
### Chimney
Creates new chimney transformer.
```typescript
import { Chimney } from "chimney-ts";
const transformer = new Chimney(fromObj).into();
```
__type constraints__
+ `fromObj` value must extends `{} | {}[] | Promise<{}>` type.
+ `Into` type must extends `{}` type.
### Transformer#withFieldConst
Creates new transformer that fills constantValue at fieldName.
```typescript
transformer
.withFieldConst("width", 10)
.withFieldConst("height", 10)
```
Compatible code:
+ Non-monadic: `{ ...fromObj, [intoFieldName]: constValue }`
+ Array: `fromObj.map(el => ({ ...el, [intoFieldName]: constValue }))`
+ Promise: `fromObj.then(el => ({ ...el, [intoFieldName]: constValue }))`
__arguments & type constraints__
+ intoFieldName: `keyof Into` type.
+ constValue: value that extends type of `Into`
### Transformer#withFieldRenamed
Creates new transformer that renames field.
```typescript
transformer
.withFieldRenamed("size", "width")
.withFieldRenamed("size", "height")
```
Compatible code:
+ Non-monadic: `{ ...fromObj, [intoFieldName]: fromObj[fromFieldName] }`
+ Array: `fromObj.map(el => ({ ...el, [intoFieldName]: fromObj[fromFieldName] }))`
+ Promise: `fromObj.then(el => ({ ...el, [intoFieldName]: fromObj[fromFieldName] }))`
__arguments & type constraints__
+ fromFieldName: `keyof From` type.
+ intoFieldName: `keyof Into` type & `From` equals to `Into`
### Transformer#withFieldComputed
Creates new transformer that fills computed value at fieldName.
```typescript
transformer
.withFieldComputed("width", fromObj => fromObj.size * 10)
.withFieldComputed("height", fromObj => fromObj.size * 10)
```
Compatible code:
+ Non-monadic: `{ ...fromObj, [intoFieldName]: computeFn(fromObj) }`
+ Array: `fromObj.map(el => ({ ...fromObj, [intoFieldName]: computeFn(fromObj) }))`
+ Promise: `fromObj.then(el => ({ ...fromObj, [intoFieldName]: computeFn(fromObj) }))`
__arguments & type constraints__
+ intoFieldName: `keyof Into` type
+ computeFn(fromObj): function that returns value that extends `Into` type
### Transformer#transform
Returns transformed value that has `Into` type (or `Into[] | Promise`).
If transformer is not compatible with Into type, method can't call!
```typescript
transformer.transform()
```
## Changelog
### v1.2.0
+ Support Array and Promise transformation
### v1.0.2
+ Fix bug of type definitions
### v1.0.0
+ Initial release