monagree-locs 1.0.9 → 2.0.0

package/dist/index.d.ts

@@ -1,13 +1,46 @@
 import { mLoc } from "./classes";
 export declare class mCountry {
-    static getAllCountries(): mLoc[];
+    /**
+   * Retrieves an array of all countries (Only supports Nigeria for now).
+   * Set oderedList to true if you want the data ordered
+   *
+   * @returns {mLoc[]} An array of mLoc objects representing countries.
+   */
+    static getAllCountries(oderedList?: boolean): mLoc[];
+    /**
+   * Retrieves a country by its code
+   *
+   * @returns {mLoc}
+   */
     static getCountryByCode(countryCode: string): mLoc | undefined;
 }
 export declare class mState {
-    static getStatesByCountry(countryCode: string): mLoc[];
+    /**
+   * Retrieves an array of all states in the provided country code.
+   * Set oderedList to true if you want the data ordered
+   *
+   * @returns {mLoc[]} An array of mLoc objects representing states.
+   */
+    static getStatesByCountry(countryCode: string, oderedList?: boolean): mLoc[];
+    /**
+   * Retrieves a state by its code and countryCode
+   *
+   * @returns {mLoc}
+   */
     static getStateByCode(countryCode: string, stateCode: string): mLoc | undefined;
 }
 export declare class mLga {
-    static getLgasByState(countryCode: string, stateCode: string): mLoc[];
+    /**
+   * Retrieves an array of all LGAs in the specified country & state.
+   * Set oderedList to true if you want the data ordered
+   *
+   * @returns {mLoc[]} An array of mLoc objects representing LGAs.
+   */
+    static getLgasByState(countryCode: string, stateCode: string, oderedList?: boolean): mLoc[];
+    /**
+   * Retrieves an LGA by its code, state code and country code
+   *
+   * @returns {mLoc}
+   */
     static getLgaByCode(countryCode: string, stateCode: string, lgaCode: string): mLoc | undefined;
 }

package/dist/index.js

@@ -6,7 +6,13 @@ var locs_1 = require("./locs");
 var mCountry = /** @class */ (function () {
     function mCountry() {
     }
-    mCountry.getAllCountries = function () {
+    /**
+   * Retrieves an array of all countries (Only supports Nigeria for now).
+   * Set oderedList to true if you want the data ordered
+   *
+   * @returns {mLoc[]} An array of mLoc objects representing countries.
+   */
+    mCountry.getAllCountries = function (oderedList) {
         var countries = [];
         for (var countryCode in locs_1.locs) {
             if (locs_1.locs.hasOwnProperty(countryCode)) {
@@ -18,8 +24,16 @@ var mCountry = /** @class */ (function () {
                 countries.push(new classes_1.mLoc(countryCode, country));
             }
         }
+        if (oderedList) {
+            return countries.slice().sort(function (a, b) { return a.getName().localeCompare(b.getName()); });
+        }
         return countries;
     };
+    /**
+   * Retrieves a country by its code
+   *
+   * @returns {mLoc}
+   */
     mCountry.getCountryByCode = function (countryCode) {
         if (locs_1.locs[countryCode]) {
             var acountry = locs_1.locs[countryCode];
@@ -37,7 +51,13 @@ exports.mCountry = mCountry;
 var mState = /** @class */ (function () {
     function mState() {
     }
-    mState.getStatesByCountry = function (countryCode) {
+    /**
+   * Retrieves an array of all states in the provided country code.
+   * Set oderedList to true if you want the data ordered
+   *
+   * @returns {mLoc[]} An array of mLoc objects representing states.
+   */
+    mState.getStatesByCountry = function (countryCode, oderedList) {
         var states = [];
         if (locs_1.locs[countryCode]) {
             var nLoc = locs_1.locs[countryCode]['states'];
@@ -52,8 +72,16 @@ var mState = /** @class */ (function () {
                 }
             }
         }
+        if (oderedList) {
+            return states.slice().sort(function (a, b) { return a.getName().localeCompare(b.getName()); });
+        }
         return states;
     };
+    /**
+   * Retrieves a state by its code and countryCode
+   *
+   * @returns {mLoc}
+   */
     mState.getStateByCode = function (countryCode, stateCode) {
         if (locs_1.locs[countryCode]) {
             var nLoc = locs_1.locs[countryCode]['states'];
@@ -74,7 +102,13 @@ exports.mState = mState;
 var mLga = /** @class */ (function () {
     function mLga() {
     }
-    mLga.getLgasByState = function (countryCode, stateCode) {
+    /**
+   * Retrieves an array of all LGAs in the specified country & state.
+   * Set oderedList to true if you want the data ordered
+   *
+   * @returns {mLoc[]} An array of mLoc objects representing LGAs.
+   */
+    mLga.getLgasByState = function (countryCode, stateCode, oderedList) {
         var lgas = [];
         if (locs_1.locs[countryCode]) {
             var nLoc = locs_1.locs[countryCode]['states'];
@@ -88,8 +122,16 @@ var mLga = /** @class */ (function () {
                 }
             }
         }
+        if (oderedList) {
+            return lgas.slice().sort(function (a, b) { return a.getName().localeCompare(b.getName()); });
+        }
         return lgas;
     };
+    /**
+   * Retrieves an LGA by its code, state code and country code
+   *
+   * @returns {mLoc}
+   */
     mLga.getLgaByCode = function (countryCode, stateCode, lgaCode) {
         if (locs_1.locs[countryCode]) {
             var nLoc = locs_1.locs[countryCode]['states'];