typeshi 2.0.2 → 2.1.0

package/dist/utils/regex/types/StringOptions.TypeGuards.js

@@ -8,7 +8,6 @@ exports.isStringPadEnum = isStringPadEnum;
 exports.isStringReplaceParams = isStringReplaceParams;
 exports.isStringCondition = isStringCondition;
 exports.isStringStripCondition = isStringStripCondition;
-exports.DEP_isCleanStringOptions = DEP_isCleanStringOptions;
 /**
  * @file src/utils/regex/types/StringOptions.TypeGuards.ts
  */
@@ -34,7 +33,7 @@ function isStringPadOptions(value) {
     const candidate = value;
     return ((0, typeValidation_1.isObject)(candidate)
         && (0, typeValidation_1.isPositveInteger)(candidate.maxLength)
-        && (!candidate.char || (typeof candidate.char === 'string' && candidate.char.length === 1))
+        && typeValidation_1.isUndefinedOr.string(candidate.char) //  && candidate.char.length === 1
         && typeValidation_1.isUndefinedOr.type(candidate.side, isStringPadEnum));
 }
 function isStringCaseEnum(value) {
@@ -48,14 +47,15 @@ function isStringPadEnum(value) {
 function isStringReplaceParams(value) {
     const candidate = value;
     return ((0, typeValidation_1.isObject)(candidate)
-        && (typeof candidate.searchValue === 'string' || candidate.searchValue instanceof RegExp)
+        && (typeof candidate.searchValue === 'string'
+            || candidate.searchValue instanceof RegExp)
         && (typeof candidate.replaceValue === 'string'));
 }
 function isStringCondition(value) {
     const candidate = value;
     return ((0, typeValidation_1.isObject)(candidate)
         && (0, typeValidation_1.isFunction)(candidate.condition)
-        && (!candidate.args || Array.isArray(candidate.args)));
+        && typeValidation_1.isUndefinedOr.array(candidate.args));
 }
 function isStringStripCondition(value) {
     const candidate = value;
@@ -64,14 +64,3 @@ function isStringStripCondition(value) {
         && typeValidation_1.isUndefinedOr.array(candidate.args)
         && typeValidation_1.isUndefinedOr.positiveInteger(candidate.max));
 }
-/**
- * - {@link DEP_CleanStringOptions}
- * @param value `any`
- * @returns **`isCleanStringOptions`** `boolean`
- * - **`true`** if the `value` is an object with at least one key in `['strip', 'case', 'pad', 'replace']` and no other keys,
- * - **`false`** `otherwise`.
- */
-function DEP_isCleanStringOptions(value) {
-    return (value && typeof value === 'object'
-        && (0, typeValidation_1.hasKeys)(value, ['strip', 'case', 'pad', 'replace'], false, true));
-}

package/dist/utils/regex/types/StringOptions.d.ts

@@ -77,55 +77,3 @@ export declare enum RegExpFlagsEnum {
     UNICODE = "u",
     STICKY = "y"
 }
-/**
- * @typedefn **`CleanStringOptions`**
- */
-export type DEP_CleanStringOptions = {
-    strip?: DEP_StringStripOptions;
-    case?: DEP_StringCaseOptions;
-    pad?: DEP_StringPadOptions;
-    replace?: StringReplaceOptions;
-};
-/**
- * @typedefn **`StringCaseOptions`**
- * @property {boolean} [toUpper] - `true` if the string should be converted to upper case
- * @property {boolean} [toLower] - `true` if the string should be converted to lower case
- * @property {boolean} [toTitle] - `true` if the string should be converted to title case, see {@link toTitleCase}
- */
-export type DEP_StringCaseOptions = {
-    toUpper?: boolean;
-    toLower?: boolean;
-    toTitle?: boolean;
-};
-/**
- * @typedefn **`StringPadOptions`**
- * @property {number} padLength - the length of the string after padding
- * @property {string} [padChar] - the character to use for padding, defaults to ' '
- * @property {boolean} [padLeft] - `true` if the padding should be added to the left side of the string
- * @property {boolean} [padRight] - `true` if the padding should be added to the right side of the string
- */
-export type DEP_StringPadOptions = {
-    padLength: number;
-    padChar?: string;
-    padLeft?: boolean;
-    padRight?: boolean;
-};
-/**
- * @typedefn **`StringStripOptions`**
- * @property {string} char - the character to strip from the string with {@link applyStripOptions}
- * @property {boolean} [escape] - `true` if the character should be escaped
- * @property {function} [stripLeftCondition] - a function that takes a string and returns `true` if the character should be stripped from the left side of the string
- * @property {any[]} [leftArgs] - arguments to pass to the `stripLeftCondition` function
- * - if `stripLeftCondition(s, leftArgs)` is `true` or `stripLeftCondition` is `undefined` (i.e. no conditions need to be met to strip left), the left side of `s` is stripped of `char`
- * @property {function} [stripRightCondition] - a function that takes a string and returns `true` if the character should be stripped from the right side of the string
- * @property {any[]} [rightArgs] - arguments to pass to the `stripRightCondition` function
- * - if `stripRightCondition(s, rightArgs)` is `true` or `stripRightCondition` is `undefined` (i.e. no conditions need to be met to strip right), the right side of `s` is stripped of `char`
- */
-export type DEP_StringStripOptions = {
-    char: string;
-    escape?: boolean;
-    stripLeftCondition?: (s: string, ...args: any[]) => boolean;
-    leftArgs?: any[];
-    stripRightCondition?: (s: string, ...args: any[]) => boolean;
-    rightArgs?: any[];
-};

package/dist/utils/typeValidation.d.ts

@@ -1,39 +1,13 @@
 /**
  * @file src/utils/typeValidation.ts
  */
-/**
- * - alias for {@link isNullLike}
- * ... maybe should just change name of isNullLike but that might break things...
- * @param value `any` the value to check
- * @returns **`isNullLike`** `boolean` = `value is '' | (Array<any> & { length: 0 }) | null | undefined | Record<string, never>`
- * - **`true`** `if` the `value` is null, undefined, empty object (no keys), empty array, or empty string
- * - **`false`** `otherwise`
- */
-export declare const isEmpty: typeof isNullLike;
-/**
- * @param value `any` the value to check
- * @returns **`isNullLike`** `boolean` = `value is '' | (Array<any> & { length: 0 }) | null | undefined | Record<string, never>`
- * - **`true`** `if` the `value` is null, undefined, empty object (no keys), empty array, or empty string
- * - **`false`** `otherwise`
- */
-export declare function isNullLike(value: any): value is '' | null | undefined | (Array<any> & {
-    length: 0;
-}) | Record<string, never>;
-/**
- * @deprecated no type predicate b/c "A type predicate cannot reference a rest parameter.ts(1229)"
- * @param values `any[]`
- * @returns `values.some(v => `{@link isNullLike}`(v))`
- * - **`true`** `if` any of the values are null, undefined, empty object (no keys), empty array, or empty string
- * - **`false`** `otherwise`.
- */
-export declare function anyNull(...values: any[]): boolean;
 /**
  * @param value
  * @returns **`isNonEmptyArray`** `boolean` = `value is Array<T> & { length: number }`
  * - **`true`** if `value` is an array and has at least one element,
  * - **`false`** otherwise.
  */
-export declare function isNonEmptyArray<T = any>(value: any): value is Array<T> & {
+export declare function isNonEmptyArray<T>(value: any): value is Array<T> & {
     length: number;
 };
 /**
@@ -42,7 +16,7 @@ export declare function isNonEmptyArray<T = any>(value: any): value is Array<T>
  * - **`true`** if `value` is an array and has no elements,
  * - **`false`** `otherwise`
  */
-export declare function isEmptyArray<T = any>(value: any): value is Array<T> & {
+export declare function isEmptyArray<T>(value: any): value is Array<T> & {
     length: 0;
 };
 /**
@@ -64,12 +38,12 @@ export declare function isIntegerArray(value: any, requireNonNegative?: boolean,
  * - `if` `false` then `value` can be empty array
  * @returns **`isStringArray`** `boolean` = `value is Array<string> & { length: number }`
  */
-export declare function isStringArray(value: any, requireNonEmpty?: boolean): value is Array<string> & {
+export declare function isStringArray(value: any, requireNonEmpty?: boolean): value is string[] & {
     length: number;
 };
 /**
  * @note **passing in an array will return `false`.**
- * @note a value is considered trivial if {@link isNullLike}`(value)` returns `true` and vice versa
+ * @note a value is considered trivial if {@link isEmpty}`(value)` returns `true` and vice versa
  * @param obj `any` The object to check.
  * @param requireAll `boolean` - flag indicating whether all values must be nontrivial or not
  * @returns **`hasNonTrivialKeys`** `boolean`
@@ -235,6 +209,15 @@ export declare class isUndefinedOr {
     static boolean: (value: any) => value is boolean | undefined;
     static function: (value: any) => value is Function | undefined;
 }
+/**
+ * @param value `any` the value to check
+ * @returns **`isEmpty`** `boolean` = `value is '' | (Array<any> & { length: 0 }) | null | undefined | Record<string, never>`
+ * - **`true`** `if` the `value` is null, undefined, empty object (no keys), empty array, or empty string
+ * - **`false`** `otherwise`
+ */
+export declare function isEmpty(value: any): value is '' | null | undefined | (Array<any> & {
+    length: 0;
+}) | Record<string, never>;
 /**
  * these may be unnecessary, but added for completeness
  */
@@ -248,6 +231,11 @@ export declare function isBoolean(value: any): value is boolean;
  * @returns **`isFunction`** `boolean`
  */
 export declare function isFunction(value: any): value is Function;
+/**
+ * @param value
+ * @returns `value === null`
+ */
+export declare function isNull(value: unknown): value is null;
 /**
  * - passing in `null` returns `false`
  * @param value `any`

package/dist/utils/typeValidation.js

@@ -3,9 +3,7 @@
  * @file src/utils/typeValidation.ts
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isUndefinedOr = exports.isOptional = exports.isType = exports.isEmpty = void 0;
-exports.isNullLike = isNullLike;
-exports.anyNull = anyNull;
+exports.isUndefinedOr = exports.isOptional = exports.isType = void 0;
 exports.isNonEmptyArray = isNonEmptyArray;
 exports.isEmptyArray = isEmptyArray;
 exports.isIntegerArray = isIntegerArray;
@@ -19,59 +17,13 @@ exports.isPrimitiveValue = isPrimitiveValue;
 exports.isInteger = isInteger;
 exports.isObject = isObject;
 exports.isPositveInteger = isPositveInteger;
+exports.isEmpty = isEmpty;
 exports.isBoolean = isBoolean;
 exports.isFunction = isFunction;
+exports.isNull = isNull;
 exports.isUndefined = isUndefined;
 exports.isUndefinedOrNull = isUndefinedOrNull;
 const index_1 = require("./regex/index");
-/**
- * - alias for {@link isNullLike}
- * ... maybe should just change name of isNullLike but that might break things...
- * @param value `any` the value to check
- * @returns **`isNullLike`** `boolean` = `value is '' | (Array<any> & { length: 0 }) | null | undefined | Record<string, never>`
- * - **`true`** `if` the `value` is null, undefined, empty object (no keys), empty array, or empty string
- * - **`false`** `otherwise`
- */
-exports.isEmpty = isNullLike;
-/**
- * @param value `any` the value to check
- * @returns **`isNullLike`** `boolean` = `value is '' | (Array<any> & { length: 0 }) | null | undefined | Record<string, never>`
- * - **`true`** `if` the `value` is null, undefined, empty object (no keys), empty array, or empty string
- * - **`false`** `otherwise`
- */
-function isNullLike(value) {
-    if (value === null || value === undefined) {
-        return true;
-    }
-    if (typeof value === 'boolean' || typeof value === 'number') {
-        return false;
-    }
-    // Check for empty object or array
-    if (typeof value === 'object' && isEmptyArray(Object.keys(value))) {
-        return true;
-    }
-    const isNullLikeString = (typeof value === 'string'
-        && (value.trim() === ''
-            || value.toLowerCase() === 'undefined'
-            || value.toLowerCase() === 'null'));
-    if (isNullLikeString) {
-        return true;
-    }
-    return false;
-}
-/**
- * @deprecated no type predicate b/c "A type predicate cannot reference a rest parameter.ts(1229)"
- * @param values `any[]`
- * @returns `values.some(v => `{@link isNullLike}`(v))`
- * - **`true`** `if` any of the values are null, undefined, empty object (no keys), empty array, or empty string
- * - **`false`** `otherwise`.
- */
-function anyNull(...values) {
-    if (values === null || values === undefined) {
-        return true;
-    }
-    return values.some(v => isNullLike(v));
-}
 /**
  * @param value
  * @returns **`isNonEmptyArray`** `boolean` = `value is Array<T> & { length: number }`
@@ -118,7 +70,7 @@ function isStringArray(value, requireNonEmpty = true) {
 }
 /**
  * @note **passing in an array will return `false`.**
- * @note a value is considered trivial if {@link isNullLike}`(value)` returns `true` and vice versa
+ * @note a value is considered trivial if {@link isEmpty}`(value)` returns `true` and vice versa
  * @param obj `any` The object to check.
  * @param requireAll `boolean` - flag indicating whether all values must be nontrivial or not
  * @returns **`hasNonTrivialKeys`** `boolean`
@@ -130,8 +82,8 @@ function hasNonTrivialKeys(obj, requireAll = false) {
         return false;
     }
     return (requireAll
-        ? Object.values(obj).every(v => !isNullLike(v))
-        : Object.values(obj).some(v => !isNullLike(v)));
+        ? Object.values(obj).every(v => !isEmpty(v))
+        : Object.values(obj).some(v => !isEmpty(v)));
 }
 /**
  * @TODO add overload on param `keys` where keys = `{ required: string[], optional: string[] }`
@@ -439,6 +391,32 @@ isUndefinedOr.boolean = (value) => {
 isUndefinedOr.function = (value) => {
     return isUndefined(value) || isFunction(value);
 };
+/**
+ * @param value `any` the value to check
+ * @returns **`isEmpty`** `boolean` = `value is '' | (Array<any> & { length: 0 }) | null | undefined | Record<string, never>`
+ * - **`true`** `if` the `value` is null, undefined, empty object (no keys), empty array, or empty string
+ * - **`false`** `otherwise`
+ */
+function isEmpty(value) {
+    if (value === null || value === undefined) {
+        return true;
+    }
+    if (typeof value === 'boolean' || typeof value === 'number') {
+        return false;
+    }
+    // Check for empty object or array
+    if (typeof value === 'object' && isEmptyArray(Object.keys(value))) {
+        return true;
+    }
+    const isEmptyString = (typeof value === 'string'
+        && (value.trim() === ''
+            || value.toLowerCase() === 'undefined'
+            || value.toLowerCase() === 'null'));
+    if (isEmptyString) {
+        return true;
+    }
+    return false;
+}
 /**
  * these may be unnecessary, but added for completeness
  */
@@ -456,6 +434,13 @@ function isBoolean(value) {
 function isFunction(value) {
     return (typeof value === 'function');
 }
+/**
+ * @param value
+ * @returns `value === null`
+ */
+function isNull(value) {
+    return value === null;
+}
 /**
  * - passing in `null` returns `false`
  * @param value `any`

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "typeshi",
-    "version": "2.0.2",
+    "version": "2.1.0",
     "description": "TypeScript utility modules",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",