DeepTools #

[version_shield]:
[release_page]: "GitHub Release page for version 2.1.0-rc01"
[![version: 2.1.0-rc01][version_shield]][release_page]

About ##

DeepTools is a set of JavaScript utility functions that recursively operate on objects.

Usage ##

$3

``ts
function deepCopy(obj: T): T;
`

Creates a deep copy of obj.

$3

`ts
function deepEquals(obj1: unknown, obj2: unknown): boolean;
`

Checks if obj1 and obj2 are equal by recursing through their properties.

$3

`ts
function deepFreeze(arr: T[][]): readonly (readonly Readonly[])[];
`

Recursively freezes arr, all of arr's items and all items of arr's items.

`ts
function deepFreeze(arr: T[]): readonly Readonly[];
`

Recursively freezes arr and all of its items.

`ts
function deepFreeze(obj: T): Readonly;
`

Recursively freezes obj and all of its properties.

$3

`ts
function safeCopy(arr: T[][]): readonly (readonly Readonly[])[];
function safeCopy(arr: T[]): readonly Readonly[];
`

Creates a safe copy of arr by creating a deep frozen copy of it.

`ts
function safeCopy(obj: T): Readonly;
`

Creates a safe copy of obj by creating a deep frozen copy of it.

Installation ##

Using npm:

`sh
npm i @mfederczuk/deeptools
`

Using yarn:

`sh
yarn add @mfederczuk/deeptools
`

Contributing ##

Read through the Contribution Guidelines if you want to contribute to this project.

License ##

DeepTools is licensed under the GNU General Public License v3.0 or later.
For more information about copying and licensing, see the COPYING.txt` file.