@pixpilot/string 2.5.0 → 3.0.0

package/README.md

@@ -50,7 +50,7 @@ if (isString(value)) {
 
 ### Validation Functions
 
-- `isEmpty(str: string, trimWhitespace?: boolean): boolean` - Check if a string is empty
+- `isEmptyString(str: string, trimWhitespace?: boolean): boolean` - Check if a string is empty
 - `isAlphanumeric(str: string): boolean` - Check if a string contains only alphanumeric characters
 - `isEmail(str: string): boolean` - Check if a string is a valid email address
 - `isUrl(str: string): boolean` - Check if a string is a valid URL

package/dist/index.cjs

@@ -8,7 +8,8 @@ exports.capitalizeFirst = require_manipulation.capitalizeFirst;
 exports.countOccurrences = require_manipulation.countOccurrences;
 exports.isAlphanumeric = require_validation.isAlphanumeric;
 exports.isEmail = require_validation.isEmail;
-exports.isEmpty = require_validation.isEmpty;
+exports.isEmptyString = require_validation.isEmptyString;
+exports.isEmptyStringOrNil = require_validation.isEmptyStringOrNil;
 exports.isString = require_type_guards.isString;
 exports.isUrl = require_validation.isUrl;
 exports.normalizeSpaces = require_manipulation.normalizeSpaces;

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toNoCase, toPascalCase, toPascalSnakeCase, toPathCase, toSentenceCase, toSnakeCase, toTrainCase } from "./case.cjs";
 import { capitalize, capitalizeFirst, countOccurrences, normalizeSpaces, padEnd, padStart, removeWhitespace, repeat, reverse, truncate, words } from "./manipulation.cjs";
 import { isString } from "./type-guards.cjs";
-import { isAlphanumeric, isEmail, isEmpty, isUrl } from "./validation.cjs";
-export { capitalize, capitalizeFirst, countOccurrences, isAlphanumeric, isEmail, isEmpty, isString, isUrl, normalizeSpaces, padEnd, padStart, removeWhitespace, repeat, reverse, toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toNoCase, toPascalCase, toPascalSnakeCase, toPathCase, toSentenceCase, toSnakeCase, toTrainCase, truncate, words };
+import { isAlphanumeric, isEmail, isEmptyString, isEmptyStringOrNil, isUrl } from "./validation.cjs";
+export { capitalize, capitalizeFirst, countOccurrences, isAlphanumeric, isEmail, isEmptyString, isEmptyStringOrNil, isString, isUrl, normalizeSpaces, padEnd, padStart, removeWhitespace, repeat, reverse, toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toNoCase, toPascalCase, toPascalSnakeCase, toPathCase, toSentenceCase, toSnakeCase, toTrainCase, truncate, words };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toNoCase, toPascalCase, toPascalSnakeCase, toPathCase, toSentenceCase, toSnakeCase, toTrainCase } from "./case.js";
 import { capitalize, capitalizeFirst, countOccurrences, normalizeSpaces, padEnd, padStart, removeWhitespace, repeat, reverse, truncate, words } from "./manipulation.js";
 import { isString } from "./type-guards.js";
-import { isAlphanumeric, isEmail, isEmpty, isUrl } from "./validation.js";
-export { capitalize, capitalizeFirst, countOccurrences, isAlphanumeric, isEmail, isEmpty, isString, isUrl, normalizeSpaces, padEnd, padStart, removeWhitespace, repeat, reverse, toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toNoCase, toPascalCase, toPascalSnakeCase, toPathCase, toSentenceCase, toSnakeCase, toTrainCase, truncate, words };
+import { isAlphanumeric, isEmail, isEmptyString, isEmptyStringOrNil, isUrl } from "./validation.js";
+export { capitalize, capitalizeFirst, countOccurrences, isAlphanumeric, isEmail, isEmptyString, isEmptyStringOrNil, isString, isUrl, normalizeSpaces, padEnd, padStart, removeWhitespace, repeat, reverse, toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toNoCase, toPascalCase, toPascalSnakeCase, toPathCase, toSentenceCase, toSnakeCase, toTrainCase, truncate, words };

package/dist/index.js

@@ -1,6 +1,6 @@
 import { toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toNoCase, toPascalCase, toPascalSnakeCase, toPathCase, toSentenceCase, toSnakeCase, toTrainCase } from "./case.js";
 import { capitalize, capitalizeFirst, countOccurrences, normalizeSpaces, padEnd, padStart, removeWhitespace, repeat, reverse, truncate, words } from "./manipulation.js";
 import { isString } from "./type-guards.js";
-import { isAlphanumeric, isEmail, isEmpty, isUrl } from "./validation.js";
+import { isAlphanumeric, isEmail, isEmptyString, isEmptyStringOrNil, isUrl } from "./validation.js";
 
-export { capitalize, capitalizeFirst, countOccurrences, isAlphanumeric, isEmail, isEmpty, isString, isUrl, normalizeSpaces, padEnd, padStart, removeWhitespace, repeat, reverse, toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toNoCase, toPascalCase, toPascalSnakeCase, toPathCase, toSentenceCase, toSnakeCase, toTrainCase, truncate, words };
+export { capitalize, capitalizeFirst, countOccurrences, isAlphanumeric, isEmail, isEmptyString, isEmptyStringOrNil, isString, isUrl, normalizeSpaces, padEnd, padStart, removeWhitespace, repeat, reverse, toCamelCase, toCapitalCase, toConstantCase, toDotCase, toKebabCase, toNoCase, toPascalCase, toPascalSnakeCase, toPathCase, toSentenceCase, toSnakeCase, toTrainCase, truncate, words };

package/dist/validation.cjs

@@ -8,16 +8,26 @@
 * @returns True if the string is empty, false otherwise
 *
 * @example
-* ```typescript
-* isEmpty(''); // true
-* isEmpty('   '); // true
-* isEmpty('   ', false); // false
-* isEmpty('hello'); // false
-* ```
+* isEmpty('');        // true
+* isEmpty('   ');     // true
+* isEmpty('hello');   // false
+*/
+function isEmptyString(str, trimWhitespace = true) {
+	return trimWhitespace ? str.trim().length === 0 : str.length === 0;
+}
+/**
+* Like isEmptyString, but also returns true for null or undefined.
+* Use this when working with optional fields, API responses, or environment variables.
+*
+* @example
+* isEmptyStringOrNil(null);      // true
+* isEmptyStringOrNil(undefined); // true
+* isEmptyStringOrNil('   ');     // true
+* isEmptyStringOrNil('hello');   // false
 */
-function isEmpty(str, trimWhitespace = true) {
-	if (trimWhitespace) return str.trim().length === 0;
-	return str.length === 0;
+function isEmptyStringOrNil(str, trimWhitespace = true) {
+	if (str == null) return true;
+	return isEmptyString(str, trimWhitespace);
 }
 /**
 * Check if a string contains only alphanumeric characters.
@@ -74,5 +84,6 @@ function isUrl(str) {
 //#endregion
 exports.isAlphanumeric = isAlphanumeric;
 exports.isEmail = isEmail;
-exports.isEmpty = isEmpty;
+exports.isEmptyString = isEmptyString;
+exports.isEmptyStringOrNil = isEmptyStringOrNil;
 exports.isUrl = isUrl;

package/dist/validation.d.cts

@@ -7,14 +7,22 @@
  * @returns True if the string is empty, false otherwise
  *
  * @example
- * ```typescript
- * isEmpty(''); // true
- * isEmpty('   '); // true
- * isEmpty('   ', false); // false
- * isEmpty('hello'); // false
- * ```
+ * isEmpty('');        // true
+ * isEmpty('   ');     // true
+ * isEmpty('hello');   // false
+ */
+declare function isEmptyString(str: string, trimWhitespace?: boolean): boolean;
+/**
+ * Like isEmptyString, but also returns true for null or undefined.
+ * Use this when working with optional fields, API responses, or environment variables.
+ *
+ * @example
+ * isEmptyStringOrNil(null);      // true
+ * isEmptyStringOrNil(undefined); // true
+ * isEmptyStringOrNil('   ');     // true
+ * isEmptyStringOrNil('hello');   // false
  */
-declare function isEmpty(str: string, trimWhitespace?: boolean): boolean;
+declare function isEmptyStringOrNil(str: string | null | undefined, trimWhitespace?: boolean): boolean;
 /**
  * Check if a string contains only alphanumeric characters.
  *
@@ -56,4 +64,4 @@ declare function isEmail(str: string): boolean;
  */
 declare function isUrl(str: string): boolean;
 //#endregion
-export { isAlphanumeric, isEmail, isEmpty, isUrl };
+export { isAlphanumeric, isEmail, isEmptyString, isEmptyStringOrNil, isUrl };

package/dist/validation.d.ts

@@ -7,14 +7,22 @@
  * @returns True if the string is empty, false otherwise
  *
  * @example
- * ```typescript
- * isEmpty(''); // true
- * isEmpty('   '); // true
- * isEmpty('   ', false); // false
- * isEmpty('hello'); // false
- * ```
+ * isEmpty('');        // true
+ * isEmpty('   ');     // true
+ * isEmpty('hello');   // false
+ */
+declare function isEmptyString(str: string, trimWhitespace?: boolean): boolean;
+/**
+ * Like isEmptyString, but also returns true for null or undefined.
+ * Use this when working with optional fields, API responses, or environment variables.
+ *
+ * @example
+ * isEmptyStringOrNil(null);      // true
+ * isEmptyStringOrNil(undefined); // true
+ * isEmptyStringOrNil('   ');     // true
+ * isEmptyStringOrNil('hello');   // false
  */
-declare function isEmpty(str: string, trimWhitespace?: boolean): boolean;
+declare function isEmptyStringOrNil(str: string | null | undefined, trimWhitespace?: boolean): boolean;
 /**
  * Check if a string contains only alphanumeric characters.
  *
@@ -56,4 +64,4 @@ declare function isEmail(str: string): boolean;
  */
 declare function isUrl(str: string): boolean;
 //#endregion
-export { isAlphanumeric, isEmail, isEmpty, isUrl };
+export { isAlphanumeric, isEmail, isEmptyString, isEmptyStringOrNil, isUrl };

package/dist/validation.js

@@ -7,16 +7,26 @@
 * @returns True if the string is empty, false otherwise
 *
 * @example
-* ```typescript
-* isEmpty(''); // true
-* isEmpty('   '); // true
-* isEmpty('   ', false); // false
-* isEmpty('hello'); // false
-* ```
+* isEmpty('');        // true
+* isEmpty('   ');     // true
+* isEmpty('hello');   // false
+*/
+function isEmptyString(str, trimWhitespace = true) {
+	return trimWhitespace ? str.trim().length === 0 : str.length === 0;
+}
+/**
+* Like isEmptyString, but also returns true for null or undefined.
+* Use this when working with optional fields, API responses, or environment variables.
+*
+* @example
+* isEmptyStringOrNil(null);      // true
+* isEmptyStringOrNil(undefined); // true
+* isEmptyStringOrNil('   ');     // true
+* isEmptyStringOrNil('hello');   // false
 */
-function isEmpty(str, trimWhitespace = true) {
-	if (trimWhitespace) return str.trim().length === 0;
-	return str.length === 0;
+function isEmptyStringOrNil(str, trimWhitespace = true) {
+	if (str == null) return true;
+	return isEmptyString(str, trimWhitespace);
 }
 /**
 * Check if a string contains only alphanumeric characters.
@@ -71,4 +81,4 @@ function isUrl(str) {
 }
 
 //#endregion
-export { isAlphanumeric, isEmail, isEmpty, isUrl };
+export { isAlphanumeric, isEmail, isEmptyString, isEmptyStringOrNil, isUrl };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pixpilot/string",
   "type": "module",
-  "version": "2.5.0",
+  "version": "3.0.0",
   "description": "A collection of utility functions for string manipulation and validation.",
   "author": "Pixpilot <m.doaie@hotmail.com>",
   "license": "MIT",
@@ -34,9 +34,9 @@
     "typescript": "^5.9.3",
     "@internal/eslint-config": "0.3.0",
     "@internal/prettier-config": "0.0.1",
-    "@internal/tsconfig": "0.1.0",
     "@internal/tsdown-config": "0.1.0",
-    "@internal/vitest-config": "0.1.0"
+    "@internal/vitest-config": "0.1.0",
+    "@internal/tsconfig": "0.1.0"
   },
   "prettier": "@internal/prettier-config",
   "scripts": {