@httptoolkit/util 0.1.5 → 0.1.7

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './promises';
 export * from './errors';
+export * from './text';

package/dist/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./promises"), exports);
 __exportStar(require("./errors"), exports);
+__exportStar(require("./text"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,2CAAyB;AACzB,yCAAuB"}

package/dist/promises.d.ts

@@ -8,9 +8,14 @@ export declare const delay: (ms: number, options?: {
     unref?: boolean;
 }) => Promise<void>;
 export declare function doWhile<T>(doFn: () => Promise<T>, whileFn: () => Promise<boolean> | boolean): Promise<void>;
-export interface Deferred<T> {
+/**
+ * A deferred is a promise (you can await it directly) but also exposes the promise
+ * explicitly at .promise, and exposes public resolve & reject callbacks for external
+ * resolution.
+ */
+export interface Deferred<T> extends Promise<T> {
     resolve: (arg: T) => void;
-    reject: (e?: Error) => void;
+    reject: (e: Error) => void;
     promise: Promise<T>;
 }
 export declare function getDeferred<T = void>(): Deferred<T>;

package/dist/promises.js

@@ -15,15 +15,13 @@ async function doWhile(doFn, whileFn) {
 }
 exports.doWhile = doWhile;
 function getDeferred() {
-    let resolve = undefined;
-    let reject = undefined;
-    let promise = new Promise((resolveCb, rejectCb) => {
+    let resolve;
+    let reject;
+    const promise = new Promise((resolveCb, rejectCb) => {
         resolve = resolveCb;
         reject = rejectCb;
     });
-    // TS thinks we're using these before they're assigned, which is why
-    // we need the undefined types, and the any here.
-    return { resolve, reject, promise };
+    return Object.assign(promise, { resolve, reject, promise });
 }
 exports.getDeferred = getDeferred;
 /**

package/dist/promises.js.map

@@ -1 +1 @@
-{"version":3,"file":"promises.js","sourceRoot":"","sources":["../src/promises.ts"],"names":[],"mappings":";;;AAEO,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,UAO9B,EAAE,EAAE,EAAE,CACN,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;IAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAEtC,IAAI,OAAO,CAAC,KAAK,IAAK,KAAa,CAAC,KAAK,EAAE;QACtC,KAAa,CAAC,KAAK,EAAE,CAAC;KAC1B;AACL,CAAC,CAAC,CAAC;AAdM,QAAA,KAAK,SAcX;AAEA,KAAK,UAAU,OAAO,CACzB,IAAsB,EACtB,OAAyC;IAEzC,GAAG;QACC,MAAM,IAAI,EAAE,CAAC;KAChB,QAAQ,MAAM,OAAO,EAAE,EAAE;AAC9B,CAAC;AAPD,0BAOC;AAQD,SAAgB,WAAW;IACvB,IAAI,OAAO,GAAmC,SAAS,CAAC;IACxD,IAAI,MAAM,GAAsC,SAAS,CAAC;IAE1D,IAAI,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE;QACjD,OAAO,GAAG,SAAS,CAAC;QACpB,MAAM,GAAG,QAAQ,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,oEAAoE;IACpE,iDAAiD;IACjD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAS,CAAC;AAC/C,CAAC;AAZD,kCAYC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAI,EAAoB;IACxD,IAAI,cAAsC,CAAC;IAE3C,OAAO,GAAG,EAAE;QACR,IAAI,cAAc,KAAK,SAAS,EAAE;YAC9B,cAAc,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBAC/B,cAAc,GAAG,SAAS,CAAC;YAC/B,CAAC,CAAC,CAAC;SACN;QAED,OAAO,cAAc,CAAC;IAC1B,CAAC,CAAC;AACN,CAAC;AAZD,oDAYC"}
+{"version":3,"file":"promises.js","sourceRoot":"","sources":["../src/promises.ts"],"names":[],"mappings":";;;AAEO,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,UAO9B,EAAE,EAAE,EAAE,CACN,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;IAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAEtC,IAAI,OAAO,CAAC,KAAK,IAAK,KAAa,CAAC,KAAK,EAAE;QACtC,KAAa,CAAC,KAAK,EAAE,CAAC;KAC1B;AACL,CAAC,CAAC,CAAC;AAdM,QAAA,KAAK,SAcX;AAEA,KAAK,UAAU,OAAO,CACzB,IAAsB,EACtB,OAAyC;IAEzC,GAAG;QACC,MAAM,IAAI,EAAE,CAAC;KAChB,QAAQ,MAAM,OAAO,EAAE,EAAE;AAC9B,CAAC;AAPD,0BAOC;AAaD,SAAgB,WAAW;IACvB,IAAI,OAA4B,CAAC;IACjC,IAAI,MAA6B,CAAC;IAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE;QACnD,OAAO,GAAG,SAAS,CAAC;QACpB,MAAM,GAAG,QAAQ,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;AAChE,CAAC;AAVD,kCAUC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAI,EAAoB;IACxD,IAAI,cAAsC,CAAC;IAE3C,OAAO,GAAG,EAAE;QACR,IAAI,cAAc,KAAK,SAAS,EAAE;YAC9B,cAAc,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBAC/B,cAAc,GAAG,SAAS,CAAC;YAC/B,CAAC,CAAC,CAAC;SACN;QAED,OAAO,cAAc,CAAC;IAC1B,CAAC,CAAC;AACN,CAAC;AAZD,oDAYC"}

package/dist/text.d.ts

@@ -0,0 +1,7 @@
+export declare function truncateWithEllipsis(str: string, length: number): string;
+export declare function joinAnd(val: string[], options?: {
+    separator?: string;
+    finalSeparator?: string;
+    oxfordComma?: boolean;
+}): string;
+export declare function aOrAn(value: string): "a" | "an";

package/dist/text.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.aOrAn = exports.joinAnd = exports.truncateWithEllipsis = void 0;
+function truncateWithEllipsis(str, length) {
+    if (str.length <= length) {
+        return str;
+    }
+    else {
+        return str.slice(0, length - 3) + "...";
+    }
+}
+exports.truncateWithEllipsis = truncateWithEllipsis;
+function joinAnd(val, options = {}) {
+    if (val.length === 1)
+        return val[0];
+    const separator = options.separator ?? ', ';
+    const finalSeparator = options.finalSeparator ?? 'and ';
+    const oxfordComma = options.oxfordComma ?? false;
+    return val.slice(0, -1).join(separator) +
+        (oxfordComma ? separator : ' ') +
+        finalSeparator +
+        val[val.length - 1];
+}
+exports.joinAnd = joinAnd;
+const VOWEL_ISH = ['a', 'e', 'i', 'o', 'u', 'y'];
+function aOrAn(value) {
+    if (VOWEL_ISH.includes(value[0].toLowerCase()))
+        return 'an';
+    else
+        return 'a';
+}
+exports.aOrAn = aOrAn;
+//# sourceMappingURL=text.js.map

package/dist/text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":";;;AAAA,SAAgB,oBAAoB,CAAC,GAAW,EAAE,MAAc;IAC5D,IAAI,GAAG,CAAC,MAAM,IAAI,MAAM,EAAE;QACtB,OAAO,GAAG,CAAC;KACd;SAAM;QACH,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;KAC3C;AACL,CAAC;AAND,oDAMC;AAED,SAAgB,OAAO,CAAC,GAAa,EAAE,UAOnC,EAAE;IACF,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;IAEpC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC;IAC5C,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,MAAM,CAAC;IACxD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,KAAK,CAAC;IAEjD,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;QACnC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC;QAC/B,cAAc;QACd,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC5B,CAAC;AAlBD,0BAkBC;AAED,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACjD,SAAgB,KAAK,CAAC,KAAa;IAC/B,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAAE,OAAO,IAAI,CAAC;;QACvD,OAAO,GAAG,CAAC;AACpB,CAAC;AAHD,sBAGC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@httptoolkit/util",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "A tiny utility package, sharing JS code widely used across HTTP Toolkit projects",
   "main": "dist/index.js",
   "files": [

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from './promises';
-export * from './errors';
+export * from './errors';
+export * from './text';

package/src/promises.ts

@@ -25,24 +25,27 @@ export async function doWhile<T>(
     } while (await whileFn());
 }
 
-export interface Deferred<T> {
+/**
+ * A deferred is a promise (you can await it directly) but also exposes the promise
+ * explicitly at .promise, and exposes public resolve & reject callbacks for external
+ * resolution.
+ */
+export interface Deferred<T> extends Promise<T> {
     resolve: (arg: T) => void,
-    reject: (e?: Error) => void,
+    reject: (e: Error) => void,
     promise: Promise<T>
 }
 
 export function getDeferred<T = void>(): Deferred<T> {
-    let resolve: undefined | ((arg: T) => void) = undefined;
-    let reject: undefined | ((e?: Error) => void) = undefined;
+    let resolve!: ((arg: T) => void);
+    let reject!: ((e: Error) => void);
 
-    let promise = new Promise<T>((resolveCb, rejectCb) => {
+    const promise = new Promise<T>((resolveCb, rejectCb) => {
         resolve = resolveCb;
         reject = rejectCb;
     });
 
-    // TS thinks we're using these before they're assigned, which is why
-    // we need the undefined types, and the any here.
-    return { resolve, reject, promise } as any;
+    return Object.assign(promise, { resolve, reject, promise });
 }
 
 /**

package/src/text.ts

@@ -0,0 +1,33 @@
+export function truncateWithEllipsis(str: string, length: number) {
+    if (str.length <= length) {
+        return str;
+    } else {
+        return str.slice(0, length - 3) + "...";
+    }
+}
+
+export function joinAnd(val: string[], options: {
+    // Separator between all but the last value
+    separator?: string,
+    // Separator before last value (preceeded with space or `separator` if oxfordComma is true)
+    finalSeparator?: string,
+    // Should there be a separator between the penultimate value & finalSeparator?
+    oxfordComma?: boolean
+} = {}) {
+    if (val.length === 1) return val[0];
+
+    const separator = options.separator ?? ', ';
+    const finalSeparator = options.finalSeparator ?? 'and ';
+    const oxfordComma = options.oxfordComma ?? false;
+
+    return val.slice(0, -1).join(separator) +
+        (oxfordComma ? separator : ' ') +
+        finalSeparator +
+        val[val.length - 1];
+}
+
+const VOWEL_ISH = ['a', 'e', 'i', 'o', 'u', 'y'];
+export function aOrAn(value: string) {
+    if (VOWEL_ISH.includes(value[0].toLowerCase())) return 'an';
+    else return 'a';
+}