@8ms/helpers 1.1.11 → 1.1.14

package/dist/date/getWeeksAgo.d.ts

@@ -2,5 +2,8 @@ import { DateType } from './date';
 /**
  * From a given input, move the date back X weeksAgo
  */
-declare const getWeeksAgo: (input: DateType, weeksAgo?: number) => number;
+declare const getWeeksAgo: ({ input, weeksAgo }: {
+    input: DateType;
+    weeksAgo: number;
+}) => number;
 export default getWeeksAgo;

package/dist/date/getWeeksAgo.js

@@ -9,8 +9,8 @@ var getNumber_1 = __importDefault(require("./getNumber"));
 /**
  * From a given input, move the date back X weeksAgo
  */
-var getWeeksAgo = function (input, weeksAgo) {
-    if (weeksAgo === void 0) { weeksAgo = 0; }
+var getWeeksAgo = function (_a) {
+    var input = _a.input, _b = _a.weeksAgo, weeksAgo = _b === void 0 ? 0 : _b;
     var response = (0, sub_1.default)((0, getDate_1.default)({ input: input }), { weeks: weeksAgo });
     return (0, getNumber_1.default)({ input: response });
 };

package/dist/date/index.d.ts

@@ -21,6 +21,7 @@ import getSunday from './getSunday';
 import getThisWeek from './getThisWeek';
 import getToday from './getToday';
 import getTwoWeeksAgo from './getTwoWeeksAgo';
+import getWeeksAgo from './getWeeksAgo';
 import getYesterday from './getYesterday';
 import isDateValid from './isDateValid';
 import isLastWeek from './isLastWeek';
@@ -30,4 +31,4 @@ import { predefinedTimeframes, PredefinedTimeframesType } from './predefinedTime
 import { TimeframeType } from './timeframe';
 import { timeframes } from './timeframes';
 export type { DateType, DurationType, FinancialYearType, FinancialYearWeekType, PredefinedTimeframesType, TimeframeType, };
-export { durations, durationComparisons, predefinedTimeframes, timeframes, format, getDate, getDurationHours, getDurationMinutes, getFinancialYear, getFinancialYearToDate, getFinancialYearWeeks, getLastWeek, getMax, getMin, getMonday, getNumber, getPredefinedTimeframe, getSunday, getThisWeek, getToday, getTwoWeeksAgo, getYesterday, isDateValid, isLastWeek, isThisWeek, parseExcelDate, };
+export { durations, durationComparisons, predefinedTimeframes, timeframes, format, getDate, getDurationHours, getDurationMinutes, getFinancialYear, getFinancialYearToDate, getFinancialYearWeeks, getLastWeek, getMax, getMin, getMonday, getNumber, getPredefinedTimeframe, getSunday, getThisWeek, getToday, getTwoWeeksAgo, getWeeksAgo, getYesterday, isDateValid, isLastWeek, isThisWeek, parseExcelDate, };

package/dist/date/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseExcelDate = exports.isThisWeek = exports.isLastWeek = exports.isDateValid = exports.getYesterday = exports.getTwoWeeksAgo = exports.getToday = exports.getThisWeek = exports.getSunday = exports.getPredefinedTimeframe = exports.getNumber = exports.getMonday = exports.getMin = exports.getMax = exports.getLastWeek = exports.getFinancialYearWeeks = exports.getFinancialYearToDate = exports.getFinancialYear = exports.getDurationMinutes = exports.getDurationHours = exports.getDate = exports.format = exports.timeframes = exports.predefinedTimeframes = exports.durationComparisons = exports.durations = void 0;
+exports.parseExcelDate = exports.isThisWeek = exports.isLastWeek = exports.isDateValid = exports.getYesterday = exports.getWeeksAgo = exports.getTwoWeeksAgo = exports.getToday = exports.getThisWeek = exports.getSunday = exports.getPredefinedTimeframe = exports.getNumber = exports.getMonday = exports.getMin = exports.getMax = exports.getLastWeek = exports.getFinancialYearWeeks = exports.getFinancialYearToDate = exports.getFinancialYear = exports.getDurationMinutes = exports.getDurationHours = exports.getDate = exports.format = exports.timeframes = exports.predefinedTimeframes = exports.durationComparisons = exports.durations = void 0;
 var durationComparisons_1 = require("./durationComparisons");
 Object.defineProperty(exports, "durationComparisons", { enumerable: true, get: function () { return durationComparisons_1.durationComparisons; } });
 var durations_1 = require("./durations");
@@ -42,6 +42,8 @@ var getToday_1 = __importDefault(require("./getToday"));
 exports.getToday = getToday_1.default;
 var getTwoWeeksAgo_1 = __importDefault(require("./getTwoWeeksAgo"));
 exports.getTwoWeeksAgo = getTwoWeeksAgo_1.default;
+var getWeeksAgo_1 = __importDefault(require("./getWeeksAgo"));
+exports.getWeeksAgo = getWeeksAgo_1.default;
 var getYesterday_1 = __importDefault(require("./getYesterday"));
 exports.getYesterday = getYesterday_1.default;
 var isDateValid_1 = __importDefault(require("./isDateValid"));

package/dist/eskimi/getAgeGroup.d.ts

@@ -1,7 +1,7 @@
 /**
  * Map the Age Group and return the user-friendly string.
  */
-export declare const getAgeGroup: ({ input }: {
+declare const getAgeGroup: ({ input }: {
     input: number;
 }) => string;
 export default getAgeGroup;

package/dist/eskimi/getAgeGroup.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAgeGroup = void 0;
 var ageGroups_1 = require("./ageGroups");
 /**
  * Map the Age Group and return the user-friendly string.
@@ -13,5 +12,4 @@ var getAgeGroup = function (_a) {
     }
     return 'Undefined';
 };
-exports.getAgeGroup = getAgeGroup;
-exports.default = exports.getAgeGroup;
+exports.default = getAgeGroup;

package/dist/number/getDivide.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Shorthand function to divide number, but fallback if the divisor is 0.
+ */
+declare const getDivide: ({ defaultValue, divisor, numerator }: {
+    defaultValue?: number;
+    divisor: any;
+    numerator: any;
+}) => number;
+export default getDivide;

package/dist/number/getDivide.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var getNumber_1 = __importDefault(require("./getNumber"));
+/**
+ * Shorthand function to divide number, but fallback if the divisor is 0.
+ */
+var getDivide = function (_a) {
+    var _b = _a.defaultValue, defaultValue = _b === void 0 ? 0 : _b, divisor = _a.divisor, numerator = _a.numerator;
+    var numeratorInt = (0, getNumber_1.default)({ input: numerator });
+    var divisorInt = (0, getNumber_1.default)({ input: divisor });
+    if (0 === divisorInt) {
+        return defaultValue;
+    }
+    return numeratorInt / divisorInt;
+};
+exports.default = getDivide;

package/dist/number/getPercent.d.ts

@@ -1,9 +1,9 @@
 /**
  * Get the percentage of two numbers.
  */
-declare const getPercentage: ({ defaultValue, divisor, value }: {
-    defaultValue: number;
+declare const getPercent: ({ defaultValue, divisor, value }: {
+    defaultValue?: number;
     divisor: any;
     value: any;
 }) => number;
-export default getPercentage;
+export default getPercent;

package/dist/number/getPercent.js

@@ -7,8 +7,8 @@ var getNumber_1 = __importDefault(require("./getNumber"));
 /**
  * Get the percentage of two numbers.
  */
-var getPercentage = function (_a) {
-    var defaultValue = _a.defaultValue, divisor = _a.divisor, value = _a.value;
+var getPercent = function (_a) {
+    var _b = _a.defaultValue, defaultValue = _b === void 0 ? 0 : _b, divisor = _a.divisor, value = _a.value;
     var cleanValue = (0, getNumber_1.default)({ input: value });
     var cleanDivisor = (0, getNumber_1.default)({ input: divisor });
     if (0 === cleanDivisor) {
@@ -16,4 +16,4 @@ var getPercentage = function (_a) {
     }
     return cleanValue / cleanDivisor;
 };
-exports.default = getPercentage;
+exports.default = getPercent;

package/dist/number/index.d.ts

@@ -1,5 +1,6 @@
 import getNumber from './getNumber';
+import getDivide from './getDivide';
 import getPercent from './getPercent';
 import getPercentIncrease from './getPercentIncrease';
 export type {};
-export { getNumber, getPercent, getPercentIncrease, };
+export { getDivide, getNumber, getPercent, getPercentIncrease, };

package/dist/number/index.js

@@ -3,9 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPercentIncrease = exports.getPercent = exports.getNumber = void 0;
+exports.getPercentIncrease = exports.getPercent = exports.getNumber = exports.getDivide = void 0;
 var getNumber_1 = __importDefault(require("./getNumber"));
 exports.getNumber = getNumber_1.default;
+var getDivide_1 = __importDefault(require("./getDivide"));
+exports.getDivide = getDivide_1.default;
 var getPercent_1 = __importDefault(require("./getPercent"));
 exports.getPercent = getPercent_1.default;
 var getPercentIncrease_1 = __importDefault(require("./getPercentIncrease"));

package/dist/util/defaultTo.d.ts

@@ -4,6 +4,6 @@
 declare const defaultTo: ({ defaultValue, instance, keys }: {
     defaultValue: any;
     instance: any;
-    keys: string | string[];
+    keys: any | any[];
 }) => any;
 export default defaultTo;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@8ms/helpers",
-  "version": "1.1.11",
+  "version": "1.1.14",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"