Release v1.0.3

Author: mfederczuk

.editorconfig

@@ -10,3 +10,6 @@ trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
+
+[*.diff]
+trim_trailing_whitespace = false

.eslintrc.json

@@ -0,0 +1,48 @@
+{
+	"env": {
+		"browser": true,
+		"es6": true,
+		"node": true
+	},
+	"extends": [
+		"eslint:recommended",
+		"plugin:@typescript-eslint/eslint-recommended",
+		"plugin:@typescript-eslint/recommended"
+	],
+	"globals": {
+		"Atomics": "readonly",
+		"SharedArrayBuffer": "readonly"
+	},
+	"parser": "@typescript-eslint/parser",
+	"parserOptions": {
+		"ecmaVersion": 2018,
+		"sourceType": "module"
+	},
+	"plugins": [
+		"@typescript-eslint"
+	],
+	"rules": {
+		"@typescript-eslint/no-inferrable-types": "warn",
+		"@typescript-eslint/no-namespace": "off",
+		"arrow-parens": "warn",
+		"camelcase": "warn",
+		"eqeqeq": "error",
+		"no-empty": "warn",
+		"no-extra-semi": "warn",
+		"no-inner-declarations": "off",
+		"no-mixed-spaces-and-tabs": "off",
+		"no-regex-spaces": "off",
+		"no-var": "error",
+		"prefer-const": "warn",
+		"quotes": "warn",
+		"semi": "error",
+		"space-unary-ops": [
+			"warn",
+			{
+				"words": false,
+				"nonwords": false
+			}
+		],
+		"spaced-comment": "warn"
+	}
+}

.github/ISSUE_TEMPLATE/error_report.md

@@ -7,6 +7,7 @@ labels: error
 # Error Report #
 
 * **DeepTools Version**: _____
+* **Operating System**: _____
 
 ## Description ##
 

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+out
+types

CHANGELOG.md

@@ -6,6 +6,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.3] - 2020-03-14 ##
+
+[1.0.3]: https://github.com/mfederczuk/deeptools/compare/v1.0.2...v1.0.3
+
+### Fixed ###
+
+* Fixed the signatures and implemention of some functions.
+
 ## [1.0.2] - 2019-12-13 ##
 
 [1.0.2]: https://github.com/mfederczuk/deeptools/compare/v1.0.1...v1.0.2

README.md

@@ -1,6 +1,6 @@
 # DeepTools #
 
-[version_shield]: https://img.shields.io/badge/version-1.0.2-blue.svg
+[version_shield]: https://img.shields.io/badge/version-1.0.3-blue.svg
 [latest_release]: https://github.com/mfederczuk/deep-tools/releases/latest "Latest Release"
 [![version: N/A][version_shield]][latest_release]
 [![Changelog](https://img.shields.io/badge/-Changelog-blue)](./CHANGELOG.md "Changelog")
@@ -25,36 +25,53 @@ yarn add @mfederczuk/deeptools
 
 ## Usage ##
 
-### [`deepCopy`](./src/deepCopy.js) ###
+### [`deepCopy`](./src/deepCopy.ts) ###
 
 ```ts
 function deepCopy<T>(obj: T): T;
 ```
 
 Creates a deep copy of **obj**.
 
-### [`deepEquals`](./src/deepEquals.js) ###
+### [`deepEquals`](./src/deepEquals.ts) ###
 
 ```ts
-function deepEquals(obj1: any, obj2: any): boolean;
+function deepEquals(obj1: unknown, obj2: unknown): boolean;
 ```
 
 Checks if **obj1** and **obj2** are equal by recursing through their properties.
 
-### [`deepFreeze`](./src/deepFreeze.js) ###
+### [`deepFreeze`](./src/deepFreeze.ts) ###
+
+```ts
+function deepFreeze<T>(arr: T[][]): readonly (readonly Readonly<T>[])[];
+```
+
+Recursively freezes **arr**, all of **arr**'s items and all items of **arr**'s items.
+
+```ts
+function deepFreeze<T>(arr: T[]): readonly Readonly<T>[];
+```
+
+Recursively freezes **arr** and all of its items.
 
 ```ts
-function deepFreeze<T>(arr: T[]): ReadonlyArray<T>;
-function deepFreeze<T extends Function>(fun: T): T;
 function deepFreeze<T>(obj: T): Readonly<T>;
 ```
 
-Recursively freezes **obj** with all of its properties.
+Recursively freezes **obj** and all of its properties.
+
+### [`safeCopy`](./src/safeCopy.ts) ###
+
+```ts
+function safeCopy<T>(arr: T[][]): readonly (readonly Readonly<T>[])[];
+function safeCopy<T>(arr: T[]): readonly Readonly<T>[];
+```
 
-### [`safeCopy`](./src/safeCopy.js) ###
+Creates a safe copy of **arr** by creating a deep frozen copy of it.
 
 ```ts
-function safeCopy<T>(obj: T): T;
+function safeCopy<T>(obj: T): Readonly<T>;
 ```
 
 Creates a safe copy of **obj** by creating a deep frozen copy of it.