@8ms/helpers 1.3.11 → 1.3.13

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name":            "@8ms/helpers",
 	"license":         "UNLICENSED",
-	"version":         "1.3.11",
+	"version":         "1.3.13",
 	"repository":      {
 		"type": "git",
 		"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"

package/string/getClean.d.ts

@@ -14,5 +14,5 @@ type GetClean = {
 /**
  * Shorthand function to get a clean version of a string.
  */
-declare const getCleanString: ({ accents, decoded, htmlTags, input, lowercase, propercase, punctuation, trim, underscores, uppercase, whitespace }: GetClean) => string;
-export default getCleanString;
+declare const getClean: ({ accents, decoded, htmlTags, input, lowercase, propercase, punctuation, trim, underscores, uppercase, whitespace }: GetClean) => string;
+export default getClean;

package/string/getClean.js

@@ -14,7 +14,7 @@ const getDecoded_1 = __importDefault(require("./getDecoded"));
 /**
  * Shorthand function to get a clean version of a string.
  */
-const getCleanString = ({ accents, decoded, htmlTags, input, lowercase, propercase, punctuation, trim, underscores, uppercase, whitespace }) => {
+const getClean = ({ accents, decoded, htmlTags, input, lowercase, propercase, punctuation, trim, underscores, uppercase, whitespace }) => {
     let response = (0, getString_1.default)({ input });
     if (decoded) {
         response = (0, getDecoded_1.default)({
@@ -62,4 +62,4 @@ const getCleanString = ({ accents, decoded, htmlTags, input, lowercase, properca
     }
     return response;
 };
-exports.default = getCleanString;
+exports.default = getClean;

package/util/getClean.d.ts

@@ -0,0 +1,11 @@
+type GetClean = {
+    hash?: boolean;
+    input: string;
+    lowercase?: boolean;
+    parameter?: boolean;
+};
+/**
+ * Return a clean URL with a few options.
+ */
+declare const getClean: ({ hash, input, lowercase, parameter }: GetClean) => string;
+export default getClean;

package/util/getClean.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getWithoutParameter_1 = __importDefault(require("./getWithoutParameter"));
+const getWithoutHash_1 = __importDefault(require("./getWithoutHash"));
+/**
+ * Return a clean URL with a few options.
+ */
+const getClean = ({ hash, input, lowercase, parameter }) => {
+    let response = input.trim();
+    if (parameter) {
+        response = (0, getWithoutParameter_1.default)({
+            input: response,
+        });
+    }
+    if (hash) {
+        response = (0, getWithoutHash_1.default)({
+            input: response,
+        });
+    }
+    if (lowercase) {
+        response = response.toLowerCase();
+    }
+    return response;
+};
+exports.default = getClean;

package/util/getWithoutHash.d.ts

@@ -0,0 +1,8 @@
+type GetWithoutHash = {
+    input: string;
+};
+/**
+ * Get a URL without the parameter query.
+ */
+declare const getWithoutHash: ({ input }: GetWithoutHash) => string;
+export default getWithoutHash;

package/util/getWithoutHash.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Get a URL without the parameter query.
+ */
+const getWithoutHash = ({ input }) => {
+    let response = input;
+    // Contains parameter query
+    if (-1 !== response.indexOf('#')) {
+        const split = response.split('#');
+        if (split.length > 1) {
+            response = split[0];
+        }
+    }
+    return response;
+};
+exports.default = getWithoutHash;

package/util/getWithoutParameter.d.ts

@@ -0,0 +1,8 @@
+type GetWithoutParameter = {
+    input: string;
+};
+/**
+ * Get a URL without the parameter query.
+ */
+declare const getWithoutParameter: ({ input }: GetWithoutParameter) => string;
+export default getWithoutParameter;

package/util/getWithoutParameter.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Get a URL without the parameter query.
+ */
+const getWithoutParameter = ({ input }) => {
+    let response = input;
+    // Contains parameter query
+    if (-1 !== response.indexOf('?')) {
+        const split = response.split('?');
+        if (split.length > 1) {
+            response = split[0];
+        }
+    }
+    return response;
+};
+exports.default = getWithoutParameter;