feat: added sortAsync function

added promise based sorting

Author: DawnImpulse

LICENSE.txt

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright 2018-2019, Saksham (DawnImpulse)
+Copyright 2021, Saksham Khurana (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.

index.d.ts

@@ -1,3 +1,7 @@
 export declare function sort(data: object, sort: boolean): object;
 
-export declare function sort(data: object): object;
+export declare function sort(data: object): object;
+
+export declare function sortAsync(data: object,sort: boolean): Promise<object> ;
+
+export declare function sortAsync(data: object): Promise<object>;

index.js

@@ -1,7 +1,7 @@
 /*
 ISC License
 
-Copyright 2018, Saksham (DawnImpulse)
+Copyright 2021, Saksham Khurana (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.
@@ -96,5 +96,25 @@ function jsonSort(data, sort) {
         throw new Error("must be an object/array")
 }
 
+/**
+ * just like normal sort but returns promise
+ * @param data - json to be sorted
+ * @param sort - asc (true) / desc (false)
+ * @return Promise - promise of sorted json object
+ */
+async function jsonSortAsync(data, sort){
+    return new Promise((resolve, reject) => {
+        try{
+            const response = jsonSort(data,sort)
+            resolve(response)
+        }catch (e) {
+            reject(e)
+        }
+    })
+}
+
 // exporting with name as sort
-exports.sort = jsonSort;
+exports.sort = jsonSort;
+
+// exporting with name as sortAsync
+exports.sortAsync = jsonSortAsync;

yarn.lock

@@ -360,7 +360,7 @@ caseless@~0.12.0:
   resolved "https://registry.yarnpkg.com/caseless/-/caseless-0.12.0.tgz#1b681c21ff84033c826543090689420d187151dc"
   integrity sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=
 
-chai@^4.2.0:
+chai@4.2.0:
   version "4.2.0"
   resolved "https://registry.yarnpkg.com/chai/-/chai-4.2.0.tgz#760aa72cf20e3795e84b12877ce0e83737aa29e5"
   integrity sha512-XQU3bhBukrOsQCuwZndwGcCVQHyZi53fQ6Ys1Fym7E4olpIqqZZhhoFJoaKVvV17lWQoXYwgWN2nF5crA8J2jw==
@@ -510,7 +510,7 @@ core-util-is@1.0.2, core-util-is@~1.0.0:
   resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.2.tgz#b5fd54220aa2bc5ab57aab7140c940754503c1a7"
   integrity sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=
 
-coveralls@^3.0.9:
+coveralls@3.0.9:
   version "3.0.9"
   resolved "https://registry.yarnpkg.com/coveralls/-/coveralls-3.0.9.tgz#8cfc5a5525f84884e2948a0bf0f1c0e90aac0420"
   integrity sha512-nNBg3B1+4iDox5A5zqHKzUTiwl2ey4k2o0NEcVZYvl+GOSJdKBj4AJGKLv6h3SvWch7tABHePAQOSZWM9E2hMg==
@@ -1397,7 +1397,7 @@ mkdirp@0.5.1, mkdirp@^0.5.1:
   dependencies:
     minimist "0.0.8"
 
-mocha@^6.2.2:
+mocha@6.2.2:
   version "6.2.2"
   resolved "https://registry.yarnpkg.com/mocha/-/mocha-6.2.2.tgz#5d8987e28940caf8957a7d7664b910dc5b2fea20"
   integrity sha512-FgDS9Re79yU1xz5d+C4rv1G7QagNGHZ+iXF81hO8zY35YZZcLEsJVfFolfsqKFWunATEvNzMK0r/CwWd/szO9A==
@@ -1461,7 +1461,7 @@ node-preload@^0.2.0:
   dependencies:
     process-on-spawn "^1.0.0"
 
-nyc@^15.0.0:
+nyc@15.0.0:
   version "15.0.0"
   resolved "https://registry.yarnpkg.com/nyc/-/nyc-15.0.0.tgz#eb32db2c0f29242c2414fe46357f230121cfc162"
   integrity sha512-qcLBlNCKMDVuKb7d1fpxjPR8sHeMVX0CHarXAVzrVWoFrigCkYR8xcrjfXSPi5HXM7EU78L6ywO7w1c5rZNCNg==
@@ -1800,7 +1800,7 @@ restore-cursor@^2.0.0:
     onetime "^2.0.0"
     signal-exit "^3.0.2"
 
-rewire@^4.0.1:
+rewire@4.0.1:
   version "4.0.1"
   resolved "https://registry.yarnpkg.com/rewire/-/rewire-4.0.1.tgz#ba1100d400a9da759fe599fc6e0233f0879ed6da"
   integrity sha512-+7RQ/BYwTieHVXetpKhT11UbfF6v1kGhKFrtZN7UDL2PybMsSt/rpLWeEUGF5Ndsl1D5BxiCB14VDJyoX+noYw==