@stryke/string-format 0.13.2 → 0.13.4

package/dist/vowels.cjs

@@ -1 +1,40 @@
-function e(e){return!!(e?.toLowerCase().startsWith(`a`)||e.toLowerCase().startsWith(`e`)||e.toLowerCase().startsWith(`i`)||e.toLowerCase().startsWith(`o`)||e.toLowerCase().startsWith(`u`))}function t(t){return e(t)?`an`:`a`}exports.getIndefiniteArticle=t,exports.isVowel=e;
+
+//#region src/vowels.ts
+/**
+* Checks if a given string starts with a vowel (a, e, i, o, u).
+*
+* @example
+* ```ts
+* isVowel("apple"); // true
+* isVowel("Banana"); // false
+* isVowel("orange"); // true
+* isVowel("grape"); // false
+* ```
+*
+* @param value - The string to check.
+* @returns True if the string starts with a vowel, false otherwise.
+*/
+function isVowel(value) {
+	return !!(value?.toLowerCase().startsWith("a") || value.toLowerCase().startsWith("e") || value.toLowerCase().startsWith("i") || value.toLowerCase().startsWith("o") || value.toLowerCase().startsWith("u"));
+}
+/**
+* Returns the appropriate indefinite article ("a" or "an") for a given string.
+*
+* @example
+* ```ts
+* getIndefiniteArticle("apple"); // "an"
+* getIndefiniteArticle("Banana"); // "a"
+* getIndefiniteArticle("orange"); // "an"
+* getIndefiniteArticle("grape"); // "a"
+* ```
+*
+* @param value - The string to check.
+* @returns "a" if the string starts with a consonant, "an" if it starts with a vowel.
+*/
+function getIndefiniteArticle(value) {
+	return isVowel(value) ? "an" : "a";
+}
+
+//#endregion
+exports.getIndefiniteArticle = getIndefiniteArticle;
+exports.isVowel = isVowel;

package/dist/vowels.mjs

@@ -1,2 +1,39 @@
-function e(e){return!!(e?.toLowerCase().startsWith(`a`)||e.toLowerCase().startsWith(`e`)||e.toLowerCase().startsWith(`i`)||e.toLowerCase().startsWith(`o`)||e.toLowerCase().startsWith(`u`))}function t(t){return e(t)?`an`:`a`}export{t as getIndefiniteArticle,e as isVowel};
+//#region src/vowels.ts
+/**
+* Checks if a given string starts with a vowel (a, e, i, o, u).
+*
+* @example
+* ```ts
+* isVowel("apple"); // true
+* isVowel("Banana"); // false
+* isVowel("orange"); // true
+* isVowel("grape"); // false
+* ```
+*
+* @param value - The string to check.
+* @returns True if the string starts with a vowel, false otherwise.
+*/
+function isVowel(value) {
+	return !!(value?.toLowerCase().startsWith("a") || value.toLowerCase().startsWith("e") || value.toLowerCase().startsWith("i") || value.toLowerCase().startsWith("o") || value.toLowerCase().startsWith("u"));
+}
+/**
+* Returns the appropriate indefinite article ("a" or "an") for a given string.
+*
+* @example
+* ```ts
+* getIndefiniteArticle("apple"); // "an"
+* getIndefiniteArticle("Banana"); // "a"
+* getIndefiniteArticle("orange"); // "an"
+* getIndefiniteArticle("grape"); // "a"
+* ```
+*
+* @param value - The string to check.
+* @returns "a" if the string starts with a consonant, "an" if it starts with a vowel.
+*/
+function getIndefiniteArticle(value) {
+	return isVowel(value) ? "an" : "a";
+}
+
+//#endregion
+export { getIndefiniteArticle, isVowel };
 //# sourceMappingURL=vowels.mjs.map

package/dist/vowels.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"vowels.mjs","names":[],"sources":["../src/vowels.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\n/**\n * Checks if a given string starts with a vowel (a, e, i, o, u).\n *\n * @example\n * ```ts\n * isVowel(\"apple\"); // true\n * isVowel(\"Banana\"); // false\n * isVowel(\"orange\"); // true\n * isVowel(\"grape\"); // false\n * ```\n *\n * @param value - The string to check.\n * @returns True if the string starts with a vowel, false otherwise.\n */\nexport function isVowel(value: string): boolean {\n  return !!(\n    value?.toLowerCase().startsWith(\"a\") ||\n    value.toLowerCase().startsWith(\"e\") ||\n    value.toLowerCase().startsWith(\"i\") ||\n    value.toLowerCase().startsWith(\"o\") ||\n    value.toLowerCase().startsWith(\"u\")\n  );\n}\n\n/**\n * Returns the appropriate indefinite article (\"a\" or \"an\") for a given string.\n *\n * @example\n * ```ts\n * getIndefiniteArticle(\"apple\"); // \"an\"\n * getIndefiniteArticle(\"Banana\"); // \"a\"\n * getIndefiniteArticle(\"orange\"); // \"an\"\n * getIndefiniteArticle(\"grape\"); // \"a\"\n * ```\n *\n * @param value - The string to check.\n * @returns \"a\" if the string starts with a consonant, \"an\" if it starts with a vowel.\n */\nexport function getIndefiniteArticle(value: string): \"a\" | \"an\" {\n  return isVowel(value) ? \"an\" : \"a\";\n}\n"],"mappings":"AAgCA,SAAgB,EAAQ,EAAwB,CAC9C,MAAO,CAAC,EACN,GAAO,aAAa,CAAC,WAAW,IAAI,EACpC,EAAM,aAAa,CAAC,WAAW,IAAI,EACnC,EAAM,aAAa,CAAC,WAAW,IAAI,EACnC,EAAM,aAAa,CAAC,WAAW,IAAI,EACnC,EAAM,aAAa,CAAC,WAAW,IAAI,EAkBvC,SAAgB,EAAqB,EAA2B,CAC9D,OAAO,EAAQ,EAAM,CAAG,KAAO"}
+{"version":3,"file":"vowels.mjs","names":[],"sources":["../src/vowels.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\n/**\n * Checks if a given string starts with a vowel (a, e, i, o, u).\n *\n * @example\n * ```ts\n * isVowel(\"apple\"); // true\n * isVowel(\"Banana\"); // false\n * isVowel(\"orange\"); // true\n * isVowel(\"grape\"); // false\n * ```\n *\n * @param value - The string to check.\n * @returns True if the string starts with a vowel, false otherwise.\n */\nexport function isVowel(value: string): boolean {\n  return !!(\n    value?.toLowerCase().startsWith(\"a\") ||\n    value.toLowerCase().startsWith(\"e\") ||\n    value.toLowerCase().startsWith(\"i\") ||\n    value.toLowerCase().startsWith(\"o\") ||\n    value.toLowerCase().startsWith(\"u\")\n  );\n}\n\n/**\n * Returns the appropriate indefinite article (\"a\" or \"an\") for a given string.\n *\n * @example\n * ```ts\n * getIndefiniteArticle(\"apple\"); // \"an\"\n * getIndefiniteArticle(\"Banana\"); // \"a\"\n * getIndefiniteArticle(\"orange\"); // \"an\"\n * getIndefiniteArticle(\"grape\"); // \"a\"\n * ```\n *\n * @param value - The string to check.\n * @returns \"a\" if the string starts with a consonant, \"an\" if it starts with a vowel.\n */\nexport function getIndefiniteArticle(value: string): \"a\" | \"an\" {\n  return isVowel(value) ? \"an\" : \"a\";\n}\n"],"mappings":";;;;;;;;;;;;;;;AAgCA,SAAgB,QAAQ,OAAwB;AAC9C,QAAO,CAAC,EACN,OAAO,aAAa,CAAC,WAAW,IAAI,IACpC,MAAM,aAAa,CAAC,WAAW,IAAI,IACnC,MAAM,aAAa,CAAC,WAAW,IAAI,IACnC,MAAM,aAAa,CAAC,WAAW,IAAI,IACnC,MAAM,aAAa,CAAC,WAAW,IAAI;;;;;;;;;;;;;;;;AAkBvC,SAAgB,qBAAqB,OAA2B;AAC9D,QAAO,QAAQ,MAAM,GAAG,OAAO"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/string-format",
-  "version": "0.13.2",
+  "version": "0.13.4",
   "type": "module",
   "description": "A package containing utility functions to transform strings into various formats.",
   "repository": {
@@ -127,5 +127,5 @@
   "types": "./dist/index.d.cts",
   "devDependencies": { "tsdown": "^0.17.2" },
   "publishConfig": { "access": "public" },
-  "gitHead": "8b7fc067d9cb2000a264ca3829f8c94c1b5e4424"
+  "gitHead": "e56e13fe0b09b8e53917efa1aab3877bc96383f7"
 }