@ezez/utils 1.1.0 → 1.2.0

package/esm/stripPrefix.js

@@ -0,0 +1,8 @@
+const stripPrefix = (from, prefix) => {
+    if (from.startsWith(prefix)) {
+        return from.slice(prefix.length);
+    }
+    return from;
+};
+export { stripPrefix, };
+//# sourceMappingURL=stripPrefix.js.map

package/esm/stripPrefix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripPrefix.js","sourceRoot":"","sources":["../src/stripPrefix.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,MAAc,EAAU,EAAE;IACzD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;KACpC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,OAAO,EACH,WAAW,GACd,CAAC"}

package/esm/stripSuffix.d.ts

@@ -0,0 +1,3 @@
+declare const stripSuffix: (from: string, suffix: string) => string;
+export { stripSuffix, };
+//# sourceMappingURL=stripSuffix.d.ts.map

package/esm/stripSuffix.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripSuffix.d.ts","sourceRoot":"","sources":["../src/stripSuffix.ts"],"names":[],"mappings":"AAMA,QAAA,MAAM,WAAW,SAAU,MAAM,UAAU,MAAM,KAAG,MAKnD,CAAC;AAEF,OAAO,EACH,WAAW,GACd,CAAC"}

package/esm/stripSuffix.js

@@ -0,0 +1,8 @@
+const stripSuffix = (from, suffix) => {
+    if (from.endsWith(suffix)) {
+        return from.slice(0, -suffix.length);
+    }
+    return from;
+};
+export { stripSuffix, };
+//# sourceMappingURL=stripSuffix.js.map

package/esm/stripSuffix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripSuffix.js","sourceRoot":"","sources":["../src/stripSuffix.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,MAAc,EAAU,EAAE;IACzD,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;KACxC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,OAAO,EACH,WAAW,GACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ezez/utils",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "repository": "https://github.com/dzek69/bottom-line.git",
   "author": "Jacek Nowacki @dzek69 <git-public@dzek.eu>",
   "license": "MIT",

package/src/ensureDate.spec.ts

@@ -0,0 +1,13 @@
+import { ensureDate } from "./ensureDate.js";
+
+describe("ensureDate", function() {
+    it("should convert timestamps to date instances", function() {
+        ensureDate(123456789).must.be.instanceOf(Date);
+        ensureDate(123456789).getTime().must.equal(123456789);
+    });
+
+    it("should return the same date instance", function() {
+        const date = new Date(123456789);
+        ensureDate(date).must.equal(date);
+    });
+});

package/src/ensureDate.ts

@@ -0,0 +1,18 @@
+/**
+ * Ensure that the date value is a Date instance
+ *
+ * @example ensureDate(123456789); // Date(123456789)
+ * @example ensureDate(new Date(123456789)); // Date(123456789) -- same instance as given
+ * @see {@link ensureTimestamp}
+ * @param {Date | number} date - date value
+ */
+const ensureDate = (date: Date | number): Date => {
+    if (typeof date === "number") {
+        return new Date(date);
+    }
+    return date;
+};
+
+export {
+    ensureDate,
+};

package/src/ensurePrefix.spec.ts

@@ -0,0 +1,11 @@
+import { ensurePrefix } from "./ensurePrefix.js";
+
+describe("ensure prefix", function() {
+    it("adds prefix", function() {
+        ensurePrefix("1234bbcc", "0x").must.equal("0x1234bbcc");
+    });
+
+    it("doesn't add prefix if already present", function() {
+        ensurePrefix("0x1234bbcc", "0x").must.equal("0x1234bbcc");
+    });
+});

package/src/ensurePrefix.ts

@@ -0,0 +1,18 @@
+/**
+ * Add prefix to string if it doesn't already have it
+ *
+ * @example ensurePrefix("1234bbcc", "0x") -> "0x1234bbcc"
+ * @example ensurePrefix("0x1234bbcc", "0x") -> "0x1234bbcc"
+ * @param {string} string - string to add prefix to
+ * @param {string} prefix - prefix to add
+ */
+const ensurePrefix = (string: string, prefix: string) => {
+    if (string.startsWith(prefix)) {
+        return string;
+    }
+    return prefix + string;
+};
+
+export {
+    ensurePrefix,
+};

package/src/ensureSuffix.spec.ts

@@ -0,0 +1,11 @@
+import { ensureSuffix } from "./ensureSuffix.js";
+
+describe("ensure suffix", function() {
+    it("adds suffix to a string", function() {
+        ensureSuffix("hello world", ".").must.equal("hello world.");
+    });
+
+    it("doesn't add suffix if already present", function() {
+        ensureSuffix("hello world.", ".").must.equal("hello world.");
+    });
+});

package/src/ensureSuffix.ts

@@ -0,0 +1,18 @@
+/**
+ * Add suffix to string if it does not already end with it
+ *
+ * @example ensureSuffix("hello world", ".") -> "hello world."
+ * @example ensureSuffix("hello world.", ".") -> "hello world."
+ * @param {string} string - string to add suffix to
+ * @param {string} suffix - suffix to add
+ */
+const ensureSuffix = (string: string, suffix: string) => {
+    if (string.endsWith(suffix)) {
+        return string;
+    }
+    return string + suffix;
+};
+
+export {
+    ensureSuffix,
+};

package/src/ensureTimestamp.spec.ts

@@ -0,0 +1,11 @@
+import { ensureTimestamp } from "./ensureTimestamp.js";
+
+describe("ensure timestamp", function() {
+    it("returns number if number given", function() {
+        ensureTimestamp(123456789).must.equal(123456789);
+    });
+
+    it("returns number if date given", function() {
+        ensureTimestamp(new Date(123456789)).must.equal(123456789);
+    });
+});

package/src/ensureTimestamp.ts

@@ -0,0 +1,18 @@
+/**
+ * Ensures that the given date value is a numeric timestamp.
+ *
+ * @example ensureTimestamp(123456789); // 123456789
+ * @example ensureTimestamp(new Date(123456789)); // 123456789
+ * @see {@link ensureDate}
+ * @param {Date | number} date - date value
+ */
+const ensureTimestamp = (date: Date | number): number => {
+    if (typeof date === "number") {
+        return date;
+    }
+    return date.getTime();
+};
+
+export {
+    ensureTimestamp,
+};

package/src/index.ts

@@ -1,9 +1,13 @@
 /* eslint-disable import/max-dependencies */
+export * from "./ensurePrefix.js";
+export * from "./ensureSuffix.js";
 export * from "./cap.js";
 export * from "./capitalize.js";
 export * from "./coalesce.js";
 export * from "./ensureArray.js";
+export * from "./ensureDate.js";
 export * from "./ensureError.js";
+export * from "./ensureTimestamp.js";
 export * from "./get.js";
 export * from "./getMultiple.js";
 export * from "./insertSeparator.js";
@@ -28,6 +32,8 @@ export * from "./seq.js";
 export * from "./set.js";
 export * from "./setImmutable.js";
 export * from "./sortBy.js";
+export * from "./stripPrefix.js";
+export * from "./stripSuffix.js";
 export * from "./throttle.js";
 export * from "./truthy.js";
 export * from "./wait.js";

package/src/stripPrefix.spec.ts

@@ -0,0 +1,13 @@
+import { stripPrefix } from "./stripPrefix.js";
+
+describe("strip prefix", function() {
+    it("should strip prefix if string has it", function() {
+        stripPrefix("abc", "a").must.equal("bc");
+        stripPrefix("hello world", "hello").must.equal(" world");
+    });
+
+    it("should keep the string as it is when string don't have specified prefix", function() {
+        stripPrefix("abc", "b").must.equal("abc");
+        stripPrefix("hello world", "world").must.equal("hello world");
+    });
+});

package/src/stripPrefix.ts

@@ -0,0 +1,15 @@
+/**
+ * Strip a prefix from a string.
+ * @param {string} from - string to strip prefix from
+ * @param {string} prefix - prefix to strip
+ */
+const stripPrefix = (from: string, prefix: string): string => {
+    if (from.startsWith(prefix)) {
+        return from.slice(prefix.length);
+    }
+    return from;
+};
+
+export {
+    stripPrefix,
+};

package/src/stripSuffix.spec.ts

@@ -0,0 +1,13 @@
+import { stripSuffix } from "./stripSuffix.js";
+
+describe("strip suffix", function() {
+    it("should strip suffix if string has it", function() {
+        stripSuffix("abc", "c").must.equal("ab");
+        stripSuffix("hello world", "world").must.equal("hello ");
+    });
+
+    it("should keep the string as it is when string don't have specified suffix", function() {
+        stripSuffix("abc", "b").must.equal("abc");
+        stripSuffix("hello world", "hello").must.equal("hello world");
+    });
+});

package/src/stripSuffix.ts

@@ -0,0 +1,16 @@
+/**
+ * Strip a suffix from a string.
+ *
+ * @param {string} from - string to strip suffix from
+ * @param {string} suffix - suffix to strip
+ */
+const stripSuffix = (from: string, suffix: string): string => {
+    if (from.endsWith(suffix)) {
+        return from.slice(0, -suffix.length);
+    }
+    return from;
+};
+
+export {
+    stripSuffix,
+};