# ts-immutable-helper

> An implementation of ImmutableHelper using TypeScript (TS 2 compatible).

Latest version **0.0.9** (published 2016-10-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install ts-immutable-helper
pnpm add ts-immutable-helper
yarn add ts-immutable-helper
bun add ts-immutable-helper
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2016-10-09 |
| First published | 2016-09-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 4.2.1 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | apoterenko |

## Links

- npm: https://www.npmjs.com/package/ts-immutable-helper
- Repository: https://github.com/apoterenko/ts-immutable-helper
- Homepage: https://github.com/apoterenko/ts-immutable-helper#readme
- Issues: https://github.com/apoterenko/ts-immutable-helper/issues
- npm.io page: https://npm.io/package/ts-immutable-helper

## Recent versions

- 0.0.9 (latest) — 2016-10-09
- 0.0.8 — 2016-09-21
- 0.0.7 — 2016-09-20
- 0.0.6 — 2016-09-20
- 0.0.5 — 2016-09-18
- 0.0.4 — 2016-09-18
- 0.0.2 — 2016-09-18
- 0.0.1 — 2016-09-12

## README

# ts-immutable-helper

An implementation of ImmutableHelper using TypeScript (TS 2 compatible).

## Description

The helper implements basic functionality such as "clone" object and "freeze" object.  

## Dependencies

* [core-js](https://www.npmjs.com/package/core-js)  

## Installation

First you need to install the npm module:
```sh
npm install ts-immutable-helper --save
```

## Use

```typescript
import {ImmutableHelper} from 'ts-immutable-helper/index';

ImmutableHelper.toClone<IDefinition>({
    a: 1,
    b: ['s1', 's2', {
        b: 1
    }]
});
```

```typescript
import {ImmutableHelper} from 'ts-immutable-helper/index';

ImmutableHelper.toImmutable<IDefinition>({
    a: 1,
    b: ['s1', 's2', {
        b: 1
    }]
});
```

```typescript
import {ImmutableHelper} from 'ts-immutable-helper/index';

class Person {
    constructor(private name: string, private id: number) {
    }

    getName(): string {
        return this.name;
    }
}

ImmutableHelper.toImmutable(new Person("Tomas", 123));
```

## Publish

```sh
npm deploy
```

## License

Licensed under MIT.

---
_Source: https://npm.io/package/ts-immutable-helper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
