@zinaid/str 0.0.6 → 0.0.8

package/dist/pluralizer/index.d.ts

@@ -2,9 +2,44 @@ import { default as pluralize } from 'pluralize';
 export interface PluralizerRules {
     uncountable: string[];
 }
+/**
+ * Pluralize the last word of an English, studly caps case string.
+ *
+ * @param value - The studly caps case string to pluralize
+ * @param count - The count to determine pluralization (default: 2)
+ * @returns The pluralized studly caps case string
+ *
+ * @requires {@link https://www.npmjs.com/package/pluralize pluralize package}
+ *
+ * @example
+ *
+ * pluralStudly("These are the school", 4); -> "These are the schools"
+ */
+export declare function pluralStudly(value: string, count?: number): string;
+/**
+ * Pluralize the last word of an English, Pascal caps case string.
+ *
+ * @param value - The Pascal caps case string to pluralize
+ * @param count - The count to determine pluralization (default: 2)
+ * @returns The pluralized Pascal caps case string
+ *
+ * @requires {@link https://www.npmjs.com/package/pluralize pluralize package}
+ *
+ * @example
+ *
+ * pluralPascal("These are the school", 4); -> "These are the schools"
+ */
+export declare function pluralPascal(value: string, count?: number): string;
 /**
  * Get the plural form of an English word.
  *
+ * @param value - The word to pluralize.
+ * @param count - The count to determine pluralization (default: 2)
+ * @param prependCount - Whether to prepend the count to the result (default: false)
+ * @returns The pluralized word, optionally with the count prepended.
+ *
+ * @requires {@link https://www.npmjs.com/package/pluralize pluralize package}
+ *
  * @example
  *
  * plural("child"); -> "children"
@@ -14,26 +49,52 @@ export interface PluralizerRules {
 export declare function plural(value: string, count?: number, prependCount?: boolean): string;
 /**
  * Get the singular form of an English word.
+ *
+ * @param value - The word to singularize.
+ * @returns The singular form of the word.
+ *
+ * @requires {@link https://www.npmjs.com/package/pluralize pluralize package}
  */
 export declare function singular(value: string): string;
 /**
  * Determine if the given value is uncountable.
+ *
+ * @param value - The word to check.
+ * @returns True if the word is uncountable, false otherwise.
+ *
+ * @requires {@link https://www.npmjs.com/package/pluralize pluralize package}
  */
 export declare function uncountable(value: string): boolean;
 /**
  * Determine if the given value is plural.
+ *
+ * @param value - The word to check.
+ * @returns True if the word is plural, false otherwise.
+ *
+ * @requires {@link https://www.npmjs.com/package/pluralize pluralize package}
  */
 export declare function isPlural(value?: string): boolean;
 /**
  * Determine if the given value is singular.
+ *
+ * @param value - The word to check.
+ * @returns True if the word is singular, false otherwise.
+ *
+ * @requires {@link https://www.npmjs.com/package/pluralize pluralize package}
  */
 export declare function isSingular(value?: string): boolean;
 /**
  * Attempt to match the case on two strings
+ *
+ * @param value - The string to adjust.
+ * @param comparison - The string to match the case against.
+ * @returns The adjusted string with matched case.
  */
 export declare function matchCase(value: string, comparison: string): string;
 /**
  * Get the pluralize instance
+ *
+ * @returns The pluralize instance.
  */
 export declare function inflector(): typeof pluralize;
 //# sourceMappingURL=index.d.ts.map

package/dist/pluralizer/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/pluralizer/index.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,MAAM,WAAW,eAAe;IAC5B,WAAW,EAAE,MAAM,EAAE,CAAC;CACzB;AAoDD;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAClB,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,MAAU,EACjB,YAAY,GAAE,OAAe,GAC9B,MAAM,CAKR;AAeD;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAI9C;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAElD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,GAAE,MAAW,GAAG,OAAO,CAEpD;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,KAAK,GAAE,MAAW,GAAG,OAAO,CAEtD;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAiBnE;AAED;;GAEG;AACH,wBAAgB,SAAS,IAAI,OAAO,SAAS,CAU5C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/pluralizer/index.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,MAAM,WAAW,eAAe;IAC5B,WAAW,EAAE,MAAM,EAAE,CAAC;CACzB;AAoDD;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAU,GAAG,MAAM,CAKrE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAU,GAAG,MAAM,CAErE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,MAAM,CAClB,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,MAAU,EACjB,YAAY,GAAE,OAAe,GAC9B,MAAM,CAKR;AAqBD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAI9C;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAElD;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,KAAK,GAAE,MAAW,GAAG,OAAO,CAEpD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,KAAK,GAAE,MAAW,GAAG,OAAO,CAEtD;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAiBnE;AAED;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,OAAO,SAAS,CAU5C"}

package/dist/pluralizer/index.js

@@ -1,7 +1,7 @@
-import { format as a } from "@zinaid/num";
-import { isUndefined as s } from "@zinaid/utils";
-import l from "pluralize";
-let r;
+import { format as s } from "@zinaid/num";
+import { isUndefined as l } from "@zinaid/utils";
+import f from "pluralize";
+let t;
 const o = {
   uncountable: [
     "audio",
@@ -49,42 +49,51 @@ const o = {
     "wheat"
   ]
 };
-function w(e, n = 2, i = !1) {
-  return (i ? a(n) + " " : "") + f(e, n);
+function c(e, n = 2) {
+  const r = e.split(/(?=[A-Z])/), a = String(r.pop());
+  return r.join("") + p(a, n);
 }
-function f(e, n) {
-  if (Math.abs(n) === 1 || c(e))
+function h(e, n = 2) {
+  return c(e, n);
+}
+function p(e, n = 2, r = !1) {
+  return (r ? s(n) + " " : "") + d(e, n);
+}
+function d(e, n) {
+  if (Math.abs(n) === 1 || m(e))
     return e;
-  const i = t().plural(e);
-  return u(i, e);
+  const r = i().plural(e);
+  return u(r, e);
 }
-function b(e) {
-  const n = t().singular(e);
+function C(e) {
+  const n = i().singular(e);
   return u(n, e);
 }
-function c(e) {
+function m(e) {
   return o.uncountable.includes(e.toLowerCase());
 }
-function g(e = "") {
-  return t().isPlural(e);
+function U(e = "") {
+  return i().isPlural(e);
 }
-function h(e = "") {
-  return t().isSingular(e);
+function k(e = "") {
+  return i().isSingular(e);
 }
 function u(e, n) {
   return n.toLowerCase() === n ? e.toLowerCase() : n.toUpperCase() === n ? e.toUpperCase() : n[0] && n[0].toUpperCase() + n.slice(1) === n ? (e[0] ?? "").toUpperCase() + e.slice(1) : e;
 }
-function t() {
-  return s(r) && (r = l, o.uncountable.forEach(
-    (e) => r.addUncountableRule(e)
-  )), r;
+function i() {
+  return l(t) && (t = f, o.uncountable.forEach(
+    (e) => t.addUncountableRule(e)
+  )), t;
 }
 export {
-  t as inflector,
-  g as isPlural,
-  h as isSingular,
+  i as inflector,
+  U as isPlural,
+  k as isSingular,
   u as matchCase,
-  w as plural,
-  b as singular,
-  c as uncountable
+  p as plural,
+  h as pluralPascal,
+  c as pluralStudly,
+  C as singular,
+  m as uncountable
 };

package/dist/replacer/index.d.ts

@@ -1,31 +1,31 @@
 /**
  * Returns the portion of the string specified by the start and length parameters.
  *
- * @param string
- * @param start
- * @param length
- * @returns
+ * @param string - The input string.
+ * @param start - The starting position. If negative, it starts that many characters from the end of the string.
+ * @param length - The number of characters to return. If omitted or null, returns all characters from start to the end of the string. If negative, omits that many characters from the end.
+ * @returns The extracted substring.
  */
 export declare function substr(string: string, start: number, length?: number | null): string;
 /**
  * Returns the number of substring occurrences.
  *
- * @param haystack
- * @param needle
- * @param offset
- * @param length
- * @returns
+ * @param haystack - The string to search within.
+ * @param needle - The substring to count.
+ * @param offset - The starting position for the search. If negative, it starts that many characters from the end of the string.
+ * @param length - The length of the segment to search within. If omitted or null, searches to the end of the string. If negative, omits that many characters from the end.
+ * @returns The number of occurrences of the substring within the specified segment.
  */
 export declare function substrCount(haystack: string, needle: string, offset?: number, length?: number | null): number;
 /**
  * Replace text within a portion of a string.
  * Properly handles multibyte characters.
  *
- * @param value
- * @param replace
- * @param offset
- * @param length
- * @returns
+ * @param value - The original string.
+ * @param replace - The replacement string or an array of replacement strings.
+ * @param offset - The starting position for the replacement. If negative, it starts that many characters from the end of the string.
+ * @param length - The number of characters to replace. If omitted or null, replaces all characters from offset to the end of the string. If negative, omits that many characters from the end.
+ * @returns The modified string or an array of modified strings if multiple replacements are provided.
  */
 export declare function substrReplace(value: string, replace: string | string[], offset?: number | number[], length?: number | number[] | null): string | string[];
 //# sourceMappingURL=index.d.ts.map