New : Typescript support

Added support for typescript by adding declaration file

Author: DawnImpulse

README.md

@@ -1,104 +1,97 @@
+# json-keys-sort    
+[![Build Status](https://travis-ci.org/DawnImpulse/json-keys-sort.svg?branch=master)](https://travis-ci.org/DawnImpulse/json-keys-sort) ![wait-loop](https://img.shields.io/npm/dt/json-keys-sort.svg)
+ > Sorting a json object based on keys either ascending or descending & even recursively    
+
+### Latest Changes
+- `v1.3.0`
+	- Added support for Typescript
+### Example -   
+> Note : focus on **keys** not values  
   
-# json-keys-sort  
-[![Build Status](https://travis-ci.org/DawnImpulse/json-keys-sort.svg?branch=master)](https://travis-ci.org/DawnImpulse/json-keys-sort)  
-> Sorting a json object based on keys either ascending or descending & even recursively  
+~~~~    
+const json = require('json-keys-sort');    
+var data = {    
+	"zoho": 4,    
+	"drake": 2,    
+	"yogo": {    
+		"jout": "3.2",    
+		"aou": {    
+			"yoyo": "3.1.3",    
+			"aalo": "3.1.1",    
+			"go": "3.1.2"    
+		}    
+	},    
+	"abc": 1    
+}    
+    
+json.sort(data,true)    
+~~~~    
+   
+Output will be -    
+~~~~    
+{    
+	"abc": 1,    
+	"drake": 2,    
+	"yogo": {                       
+		"aou": {    
+			"aalo": "3.1.1",    
+			"go": "3.1.2",    
+			"yoyo": "3.1.3"                                                 
+		},    
+		"jout": "3.2"    
+	},    
+	"zoho": 4    
+}    
+~~~~    
+    
++ function parameters    
+   - data : the json object to sort  
+   - sort :   
+      - true (default) : ascending sort , since it is default you can only call `json.sort(data)`  
+      - false : descending sort  
+> Note : the function assumes that you always provide a json object  
   
-  
-### Example - 
-  > Note : focus on **keys** not values
-
-~~~~  
-const json = require('json-keys-sort');  
-var data = {  
-               "zoho": 4,  
-               "drake": 2,  
-               "yogo": {  
-                   "jout": "3.2",  
-                   "aou": {  
-                       "yoyo": "3.1.3",  
-                       "aalo": "3.1.1",  
-                       "go": "3.1.2"  
-                   }  
-               },  
-               "abc": 1  
-           }  
-  
-json.sort(data,true)  
-~~~~  
- 
-Output will be -  
-~~~~  
-{  
-               "abc": 1,  
-               "drake": 2,  
-               "yogo": {                     
-                   "aou": {  
-                       "aalo": "3.1.1",  
-                       "go": "3.1.2",  
-                       "yoyo": "3.1.3"                                               
-                   },  
-                   "jout": "3.2"  
-               },  
-               "zoho": 4  
-           }  
-~~~~  
-  
-+ function parameters  
-	 - data : the json object to sort
-	 - sort : 
-		 - true (default) : ascending sort , since it is default you can only call `json.sort(data)`
-		 - false : descending sort
-> Note : the function assumes that you always provide a json object
-
-+ The function work recursively and sort all the inner json objects too.
++ The function work recursively and sort all the inner json objects too.  
 
 ### Versions
 
-+ `v1.2.0`
-    + Improvement : json array support
-+ `v1.1.0`
-     + Bug Fixed : descending sort fix
-     + Improvement: auto build testing via travis-ci
-+ `v1.0.1`
-     + Bug Fixed : data null checks & default true fix
-+  `v1.0.0`
-	 + Initial release - containing basic `sort` function only.
++ `v1.3.0`
+	+ Included support for typescript (added declaration file)
+	
++  `v1.2.0`
+	+ Improvement : json array support
 
-> Pull requests are always welcomed (kindly sign commits with GPG keys. **THANKS**)
++  `v1.1.0`
+	+ Bug Fixed : descending sort fix
+	+ Improvement: auto build testing via travis-ci
 
-  
++  `v1.0.1`
+	+ Bug Fixed : data null checks & default true fix
 
-### Contact
++  `v1.0.0`
+	+ Initial release - containing basic `sort` function only.
 
+> Pull requests are always welcomed (kindly sign commits with GPG keys. **THANKS**)  
+    
+### Contact  
+  
 + Twitter - [@dawnimpulse](https://twitter.com/dawnimpulse)
-
++ Email - [dawnimpulse@gmail.com](mailto:dawnimpulse@gmail.com)
 
-
-### License (ISC)
+  
+### License (ISC)  
 ~~~~
-
 ISC Licence
 
-  
-
-Copyright 2018 Saksham (DawnImpulse)
-
-  
+Copyright 2018-2019 Saksham (DawnImpulse)
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
-
 provided that the above copyright notice and this permission notice appear in all copies.
 
-  
-
 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
-
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-
 INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISIN
+~~~~
 
-WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
-
-OR PERFORMANCE OF THIS SOFTWARE.
-
-~~~~
+> Written with [StackEdit](https://stackedit.io/).

index.d.ts

@@ -0,0 +1,3 @@
+export declare function sort(data: JSON, sort: boolean): JSON;
+
+export declare function sort(data: JSON): JSON;

package.json

@@ -1,8 +1,9 @@
 {
   "name": "json-keys-sort",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Sorting a json object based on keys either ascending or descending & even recursively",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "mocha index.test.js"
   },
@@ -15,12 +16,18 @@
     "sorting",
     "json-sort",
     "sort-json",
-    "key-sort-json"
+    "key-sort-json",
+    "json-sort",
+    "object-sort",
+    "key-sorting",
+    "json-sorting",
+    "json-key-sorting"
   ],
   "author": "DawnImpulse",
   "license": "ISC",
   "devDependencies": {
     "chai": "^4.2.0",
     "mocha": "^5.2.0"
-  }
+  },
+  "dependencies": {}
 }