@@ -25,36 +25,53 @@ yarn add @mfederczuk/deeptools
25
25
26
26
## Usage ##
27
27
28
- ### [ ` deepCopy ` ] ( ./src/deepCopy.js ) ###
28
+ ### [ ` deepCopy ` ] ( ./src/deepCopy.ts ) ###
29
29
30
30
``` ts
31
31
function deepCopy<T >(obj : T ): T ;
32
32
```
33
33
34
34
Creates a deep copy of ** obj** .
35
35
36
- ### [ ` deepEquals ` ] ( ./src/deepEquals.js ) ###
36
+ ### [ ` deepEquals ` ] ( ./src/deepEquals.ts ) ###
37
37
38
38
``` ts
39
- function deepEquals(obj1 : any , obj2 : any ): boolean ;
39
+ function deepEquals(obj1 : unknown , obj2 : unknown ): boolean ;
40
40
```
41
41
42
42
Checks if ** obj1** and ** obj2** are equal by recursing through their properties.
43
43
44
- ### [ ` deepFreeze ` ] ( ./src/deepFreeze.js ) ###
44
+ ### [ ` deepFreeze ` ] ( ./src/deepFreeze.ts ) ###
45
+
46
+ ``` ts
47
+ function deepFreeze<T >(arr : T [][]): readonly (readonly Readonly <T >[])[];
48
+ ```
49
+
50
+ Recursively freezes ** arr** , all of ** arr** 's items and all items of ** arr** 's items.
51
+
52
+ ``` ts
53
+ function deepFreeze<T >(arr : T []): readonly Readonly <T >[];
54
+ ```
55
+
56
+ Recursively freezes ** arr** and all of its items.
45
57
46
58
``` ts
47
- function deepFreeze<T >(arr : T []): ReadonlyArray <T >;
48
- function deepFreeze<T extends Function >(fun : T ): T ;
49
59
function deepFreeze<T >(obj : T ): Readonly <T >;
50
60
```
51
61
52
- Recursively freezes ** obj** with all of its properties.
62
+ Recursively freezes ** obj** and all of its properties.
63
+
64
+ ### [ ` safeCopy ` ] ( ./src/safeCopy.ts ) ###
65
+
66
+ ``` ts
67
+ function safeCopy<T >(arr : T [][]): readonly (readonly Readonly <T >[])[];
68
+ function safeCopy<T >(arr : T []): readonly Readonly <T >[];
69
+ ```
53
70
54
- ### [ ` safeCopy ` ] ( ./src/safeCopy.js ) ###
71
+ Creates a safe copy of ** arr ** by creating a deep frozen copy of it.
55
72
56
73
``` ts
57
- function safeCopy<T >(obj : T ): T ;
74
+ function safeCopy<T >(obj : T ): Readonly < T > ;
58
75
```
59
76
60
77
Creates a safe copy of ** obj** by creating a deep frozen copy of it.
0 commit comments