@umatch/utils - npm Package Compare versions

Comparing version 16.0.1 to 17.0.0

lib/string/index.d.ts

@@ -6,3 +6,4 @@ import { type ForegroundColor } from 'chalk';
 type ChalkColor = typeof ForegroundColor;
-type Pluralizer = (word: string, quantity?: number, plural?: string) => string;
+type ToOrdinal = (num: number) => string;
+type ToPlural = (word: string, quantity?: number, plural?: string) => string;
 /**
@@ -21,2 +22,6 @@ * Replaces NewChar with Char in S.
 /**
+ * Returns the ordinal of a number.
+ */
+declare const ordinal: ToOrdinal;
+/**
  * Pluralizes the word if *quantity* is undefined or not 1. Uses the
@@ -27,9 +32,9 @@ * given plural or adds an 's' to the end.
  * // returns 'developers'
- * basicPluralizer('developer')
+ * plural('developer')
  * // returns 'developer'
- * basicPluralizer('developer', 1)
+ * plural('developer', 1)
  * // returns 'developers'
- * basicPluralizer('developer', 2)
+ * plural('developer', 2)
  */
-declare function basicPluralizer(word: string, quantity?: number, plural?: string): string;
+declare const plural: ToPlural;
 /**
@@ -91,3 +96,3 @@ * Pads a string on both sides to achieve the desired length.
     parts?: number;
-    pluralizer?: Pluralizer;
+    pluralizer?: ToPlural;
     short?: boolean;
@@ -130,3 +135,3 @@ }): string;
     dictionary?: DateTimeDict;
-    pluralizer?: Pluralizer;
+    pluralizer?: ToPlural;
     short?: boolean;
@@ -283,3 +288,3 @@ unitsThresholds?: readonly (readonly [DateTimeUnit, number])[];
 declare function titleCase<S extends string>(str: S, skipWords?: readonly string[]): TitleCase<S>;
-export { basicPluralizer, capitalize, center, formatStr, formatTime, getCountDown, join, joinNonEmpty, joinUrl, pad, parseBool, parseFunctionCall, parseNumber, removeAccents, rsplit, split, uncapitalize, type DateTimeDict, type JoinNonEmpty, type LastLetter, type Pluralizer, type Replace, type Trim, type Unquote, camelCase, pascalCase, sentenceCase, snakeCase, titleCase, type CamelCase, type PascalCase, type SentenceCase, type SnakeCase, type TitleCase, };
+export { capitalize, center, formatStr, formatTime, getCountDown, join, joinNonEmpty, joinUrl, ordinal, pad, parseBool, parseFunctionCall, parseNumber, plural, removeAccents, rsplit, split, uncapitalize, type DateTimeDict, type JoinNonEmpty, type LastLetter, type Replace, type ToOrdinal, type ToPlural, type Trim, type Unquote, camelCase, pascalCase, sentenceCase, snakeCase, titleCase, type CamelCase, type PascalCase, type SentenceCase, type SnakeCase, type TitleCase, };
 //# sourceMappingURL=index.d.ts.map

lib/string/index.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA,OAAc,EAAc,KAAK,eAAe,EAAE,MAAM,OAAO,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAMjC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAE1C,KAAK,UAAU,GAAG,OAAO,eAAe,CAAC;AACzC,KAAK,UAAU,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;AAE/E;;GAEG;AACH,KAAK,OAAO,CACV,CAAC,SAAS,MAAM,EAChB,IAAI,SAAS,MAAM,EACnB,OAAO,SAAS,MAAM,EACtB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,MAAM,GAAG,IAAI,GAAG,MAAM,KAAK,EAAE,GAChD,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,GAAG,GAAG,MAAM,GAAG,OAAO,EAAE,CAAC,GAC1D,GAAG,SAAS,EAAE,GACd,CAAC,GACD,GAAG,GAAG,GAAG,CAAC,EAAE,CAAC;AACjB;;GAEG;AACH,KAAK,IAAI,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,IAAI,MAAM,KAAK,EAAE,GACrD,IAAI,CAAC,KAAK,CAAC,GACX,CAAC,SAAS,GAAG,MAAM,MAAM,GAAG,GAC5B,IAAI,CAAC,MAAM,CAAC,GACZ,CAAC,CAAC;AACN;;GAEG;AACH,KAAK,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,SAAS,KAAK,GACnF,CAAC,SAAS,IAAI,MAAM,MAAM,GAAG,GAC3B,MAAM,GACN,GAAG,SAAS,KAAK,GACjB,CAAC,SAAS,IAAI,MAAM,MAAM,GAAG,GAC3B,MAAM,GACN,CAAC,GACH,CAAC,GACH,CAAC,SAAS,IAAI,MAAM,MAAM,GAAG,GAC7B,MAAM,GACN,CAAC,CAAC;AAEN;;;;;;;;;;;GAWG;AACH,iBAAS,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAGjF;AAED;;;;;GAKG;AACH,iBAAS,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,SAAM,GAAG,MAAM,CAQpE;AAED;;;;;;;;;GASG;AACH,iBAAS,SAAS,CAChB,GAAG,GAAE,MAAW,EAChB,OAAO,GAAE;IACP,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACZ,GACL,MAAM,CAQR;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,iBAAS,UAAU,CACjB,IAAI,EAAE;IACJ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,EACD,OAAO,CAAC,EAAE;IACR,UAAU,CAAC,EAAE;QACX,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,GACA,MAAM,CAgDR;AAED,KAAK,YAAY,GAAG;KAAG,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,MAAM;CAAE,GAAG;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AACF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,iBAAS,YAAY,CACnB,IAAI,EAAE,MAAM,GAAG,QAAQ,EACvB,OAAO,CAAC,EAAE;IACR,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,eAAe,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;CAChE,GACA,MAAM,CAwCR;AAED;;GAEG;AACH,iBAAS,IAAI,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAAE,GAAG,SAAM,GAAG,MAAM,CAOzD;AAED,KAAK,YAAY,CACf,CAAC,SAAS,SAAS,SAAS,EAAE,EAC9B,GAAG,SAAS,MAAM,GAAG,EAAE,EACvB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,SAAS,CAAC,MAAM,OAAO,EAAE,GAAG,MAAM,IAAI,SAAS,SAAS,SAAS,EAAE,CAAC,GAC9E,IAAI,GAAG,SAAS,SAAS,OAAO,GAC9B,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,GAC5B,OAAO,SAAS,MAAM,GACtB,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GACtB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,GAC5B,GAAG,SAAS,EAAE,GACd,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,GAChC,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,OAAO,EAAE,CAAC,GACnD,GAAG,SAAS,EAAE,GACd,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,GAAG,MAAM,CAAC,GACzC,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,OAAO,GAAG,MAAM,EAAE,CAAC,GAC5D,GAAG,CAAC;AAER;;GAEG;AACH,iBAAS,YAAY,CAAC,CAAC,SAAS,SAAS,SAAS,EAAE,EAAE,GAAG,SAAS,MAAM,GAAG,EAAE,EAC3E,KAAK,EAAE,CAAC,GAAG,SAAS,EACpB,SAAS,CAAC,EAAE,GAAG,GACd,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AASxB;;;;;;;;GAQG;AACH,iBAAS,OAAO,CAAC,GAAG,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAEpD;AAED;;GAEG;AACH,iBAAS,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAGhE;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,GAAG,CAAC,EAAE,OAAO,GAAG,OAAO,CAczE;AAED;;;;;;;;GAQG;AACH,iBAAS,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CA6D7D;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,MAAM,EACnD,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAC9B,GAAG,CAAC,EAAE,CAAC,GACN,CAAC,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,CAUzC;AAED;;GAEG;AACH,iBAAS,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED;;;;;;;;;;;;;GAaG;AACH,iBAAS,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,CAAC,SAAK,EAAE,GAAG,SAAM,GAAG,MAAM,EAAE,CAQ3E;AAED;;;;;;;;;;;;;GAaG;AACH,iBAAS,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,CAAC,SAAK,EAAE,GAAG,SAAM,GAAG,MAAM,EAAE,CAQ1E;AAED;;GAEG;AACH,iBAAS,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;AAO7D;;GAEG;AACH,iBAAS,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;AAwCjE;;GAEG;AACH,KAAK,UAAU,CACb,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,MAAM,GAAG,EAAE,IAC1B,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,IAAI,SAAS,EAAE,GACb,CAAC,GACD,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,GACzB,QAAQ,CAAC;AAEb;;GAEG;AACH,KAAK,SAAS,CACZ,CAAC,SAAS,MAAM,EAChB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,GAAG,SAAS,EAAE,GACZ,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,GACjC,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAC7B,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,GAChC,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACnC,GAAG,CAAC;AAER;;GAEG;AACH,KAAK,UAAU,CACb,CAAC,SAAS,MAAM,EAChB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,GAAG,SAAS,EAAE,GACZ,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,GAClC,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAC7B,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,GACjC,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACpC,GAAG,CAAC;AAER;;GAEG;AACH,KAAK,YAAY,CACf,CAAC,SAAS,MAAM,EAChB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,GAAG,SAAS,EAAE,GACZ,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,GACpC,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAC7B,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC,GAC7B,KAAK,SAAS,SAAS,CAAC,KAAK,CAAC,GAC9B,UAAU,CAAC,GAAG,CAAC,SAAS,GAAG,GACzB,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,GAC/C,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,GAClD,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACtC,GAAG,CAAC;AAER;;GAEG;AACH,KAAK,SAAS,CACZ,CAAC,SAAS,MAAM,EAChB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,GAAG,SAAS,EAAE,GACZ,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,GACjC,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAC7B,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,GACtC,KAAK,SAAS,SAAS,CAAC,KAAK,CAAC,GAC9B,UAAU,CAAC,GAAG,CAAC,SAAS,GAAG,GACzB,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,GAC5C,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,GAC/C,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACnC,GAAG,CAAC;AAER;;GAEG;AACH,KAAK,SAAS,CACZ,CAAC,SAAS,MAAM,EAChB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,GAAG,SAAS,EAAE,GACZ,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,GACjC,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAC7B,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,GACtC,KAAK,SAAS,SAAS,CAAC,KAAK,CAAC,GAC9B,UAAU,CAAC,GAAG,CAAC,SAAS,GAAG,GACzB,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACjC,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC,GACpC,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACnC,GAAG,CAAC;AAGR;;;;;;GAMG;AACH,iBAAS,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAEzD;AAGD;;;;;;GAMG;AACH,iBAAS,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAE3D;AAGD;;GAEG;AACH,iBAAS,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAE/D;AAGD;;;;;;GAMG;AACH,iBAAS,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAEzD;AAyBD;;;;;;;GAOG;AACH,iBAAS,SAAS,CAAC,CAAC,SAAS,MAAM,EACjC,GAAG,EAAE,CAAC,EACN,SAAS,GAAE,SAAS,MAAM,EAAuB,GAChD,SAAS,CAAC,CAAC,CAAC,CAKd;AAED,OAAO,EACL,eAAe,EACf,UAAU,EACV,MAAM,EACN,SAAS,EACT,UAAU,EACV,YAAY,EACZ,IAAI,EACJ,YAAY,EACZ,OAAO,EACP,GAAG,EACH,SAAS,EACT,iBAAiB,EACjB,WAAW,EACX,aAAa,EACb,MAAM,EACN,KAAK,EACL,YAAY,EACZ,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,IAAI,EACT,KAAK,OAAO,EAEZ,SAAS,EACT,UAAU,EACV,YAAY,EACZ,SAAS,EACT,SAAS,EACT,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,SAAS,GACf,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA,OAAc,EAAc,KAAK,eAAe,EAAE,MAAM,OAAO,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAMjC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAE1C,KAAK,UAAU,GAAG,OAAO,eAAe,CAAC;AACzC,KAAK,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;AACzC,KAAK,QAAQ,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;AAE7E;;GAEG;AACH,KAAK,OAAO,CACV,CAAC,SAAS,MAAM,EAChB,IAAI,SAAS,MAAM,EACnB,OAAO,SAAS,MAAM,EACtB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,MAAM,GAAG,IAAI,GAAG,MAAM,KAAK,EAAE,GAChD,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,GAAG,GAAG,MAAM,GAAG,OAAO,EAAE,CAAC,GAC1D,GAAG,SAAS,EAAE,GACd,CAAC,GACD,GAAG,GAAG,GAAG,CAAC,EAAE,CAAC;AACjB;;GAEG;AACH,KAAK,IAAI,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,IAAI,MAAM,KAAK,EAAE,GACrD,IAAI,CAAC,KAAK,CAAC,GACX,CAAC,SAAS,GAAG,MAAM,MAAM,GAAG,GAC5B,IAAI,CAAC,MAAM,CAAC,GACZ,CAAC,CAAC;AACN;;GAEG;AACH,KAAK,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,SAAS,KAAK,GACnF,CAAC,SAAS,IAAI,MAAM,MAAM,GAAG,GAC3B,MAAM,GACN,GAAG,SAAS,KAAK,GACjB,CAAC,SAAS,IAAI,MAAM,MAAM,GAAG,GAC3B,MAAM,GACN,CAAC,GACH,CAAC,GACH,CAAC,SAAS,IAAI,MAAM,MAAM,GAAG,GAC7B,MAAM,GACN,CAAC,CAAC;AAEN;;GAEG;AACH,QAAA,MAAM,OAAO,EAAE,SAad,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,MAAM,EAAE,QAOb,CAAC;AAEF;;;;;GAKG;AACH,iBAAS,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,SAAM,GAAG,MAAM,CAQpE;AAED;;;;;;;;;GASG;AACH,iBAAS,SAAS,CAChB,GAAG,GAAE,MAAW,EAChB,OAAO,GAAE;IACP,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACZ,GACL,MAAM,CAQR;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,iBAAS,UAAU,CACjB,IAAI,EAAE;IACJ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,EACD,OAAO,CAAC,EAAE;IACR,UAAU,CAAC,EAAE;QACX,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,GACA,MAAM,CAgDR;AAED,KAAK,YAAY,GAAG;KAAG,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,MAAM;CAAE,GAAG;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AACF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,iBAAS,YAAY,CACnB,IAAI,EAAE,MAAM,GAAG,QAAQ,EACvB,OAAO,CAAC,EAAE;IACR,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,eAAe,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;CAChE,GACA,MAAM,CAwCR;AAED;;GAEG;AACH,iBAAS,IAAI,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAAE,GAAG,SAAM,GAAG,MAAM,CAOzD;AAED,KAAK,YAAY,CACf,CAAC,SAAS,SAAS,SAAS,EAAE,EAC9B,GAAG,SAAS,MAAM,GAAG,EAAE,EACvB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,SAAS,CAAC,MAAM,OAAO,EAAE,GAAG,MAAM,IAAI,SAAS,SAAS,SAAS,EAAE,CAAC,GAC9E,IAAI,GAAG,SAAS,SAAS,OAAO,GAC9B,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,GAC5B,OAAO,SAAS,MAAM,GACtB,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GACtB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,GAC5B,GAAG,SAAS,EAAE,GACd,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,GAChC,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,OAAO,EAAE,CAAC,GACnD,GAAG,SAAS,EAAE,GACd,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,GAAG,MAAM,CAAC,GACzC,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,OAAO,GAAG,MAAM,EAAE,CAAC,GAC5D,GAAG,CAAC;AAER;;GAEG;AACH,iBAAS,YAAY,CAAC,CAAC,SAAS,SAAS,SAAS,EAAE,EAAE,GAAG,SAAS,MAAM,GAAG,EAAE,EAC3E,KAAK,EAAE,CAAC,GAAG,SAAS,EACpB,SAAS,CAAC,EAAE,GAAG,GACd,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AASxB;;;;;;;;GAQG;AACH,iBAAS,OAAO,CAAC,GAAG,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAEpD;AAED;;GAEG;AACH,iBAAS,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAGhE;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,GAAG,CAAC,EAAE,OAAO,GAAG,OAAO,CAczE;AAED;;;;;;;;GAQG;AACH,iBAAS,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CA6D7D;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,IAAI,GAAG,MAAM,EACnD,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAC9B,GAAG,CAAC,EAAE,CAAC,GACN,CAAC,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,CAUzC;AAED;;GAEG;AACH,iBAAS,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED;;;;;;;;;;;;;GAaG;AACH,iBAAS,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,CAAC,SAAK,EAAE,GAAG,SAAM,GAAG,MAAM,EAAE,CAQ3E;AAED;;;;;;;;;;;;;GAaG;AACH,iBAAS,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,CAAC,SAAK,EAAE,GAAG,SAAM,GAAG,MAAM,EAAE,CAQ1E;AAED;;GAEG;AACH,iBAAS,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;AAO7D;;GAEG;AACH,iBAAS,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;AAwCjE;;GAEG;AACH,KAAK,UAAU,CACb,CAAC,SAAS,MAAM,EAChB,QAAQ,SAAS,MAAM,GAAG,EAAE,IAC1B,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,IAAI,SAAS,EAAE,GACb,CAAC,GACD,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,GACzB,QAAQ,CAAC;AAEb;;GAEG;AACH,KAAK,SAAS,CACZ,CAAC,SAAS,MAAM,EAChB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,GAAG,SAAS,EAAE,GACZ,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,GACjC,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAC7B,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,GAChC,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACnC,GAAG,CAAC;AAER;;GAEG;AACH,KAAK,UAAU,CACb,CAAC,SAAS,MAAM,EAChB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,GAAG,SAAS,EAAE,GACZ,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,GAClC,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAC7B,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,GACjC,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACpC,GAAG,CAAC;AAER;;GAEG;AACH,KAAK,YAAY,CACf,CAAC,SAAS,MAAM,EAChB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,GAAG,SAAS,EAAE,GACZ,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,GACpC,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAC7B,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC,GAC7B,KAAK,SAAS,SAAS,CAAC,KAAK,CAAC,GAC9B,UAAU,CAAC,GAAG,CAAC,SAAS,GAAG,GACzB,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,GAC/C,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,GAClD,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACtC,GAAG,CAAC;AAER;;GAEG;AACH,KAAK,SAAS,CACZ,CAAC,SAAS,MAAM,EAChB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,GAAG,SAAS,EAAE,GACZ,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,GACjC,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAC7B,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,GACtC,KAAK,SAAS,SAAS,CAAC,KAAK,CAAC,GAC9B,UAAU,CAAC,GAAG,CAAC,SAAS,GAAG,GACzB,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,GAC5C,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,GAC/C,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACnC,GAAG,CAAC;AAER;;GAEG;AACH,KAAK,SAAS,CACZ,CAAC,SAAS,MAAM,EAChB,GAAG,SAAS,MAAM,GAAG,EAAE,IACrB,CAAC,SAAS,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,GACvC,GAAG,SAAS,EAAE,GACZ,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,GACjC,KAAK,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,GAC7B,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,GACtC,KAAK,SAAS,SAAS,CAAC,KAAK,CAAC,GAC9B,UAAU,CAAC,GAAG,CAAC,SAAS,GAAG,GACzB,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACjC,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC,GACpC,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,GACnC,GAAG,CAAC;AAGR;;;;;;GAMG;AACH,iBAAS,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAEzD;AAGD;;;;;;GAMG;AACH,iBAAS,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAE3D;AAGD;;GAEG;AACH,iBAAS,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAE/D;AAGD;;;;;;GAMG;AACH,iBAAS,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAEzD;AAyBD;;;;;;;GAOG;AACH,iBAAS,SAAS,CAAC,CAAC,SAAS,MAAM,EACjC,GAAG,EAAE,CAAC,EACN,SAAS,GAAE,SAAS,MAAM,EAAuB,GAChD,SAAS,CAAC,CAAC,CAAC,CAKd;AAED,OAAO,EACL,UAAU,EACV,MAAM,EACN,SAAS,EACT,UAAU,EACV,YAAY,EACZ,IAAI,EACJ,YAAY,EACZ,OAAO,EACP,OAAO,EACP,GAAG,EACH,SAAS,EACT,iBAAiB,EACjB,WAAW,EACX,MAAM,EACN,aAAa,EACb,MAAM,EACN,KAAK,EACL,YAAY,EACZ,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,SAAS,EACd,KAAK,QAAQ,EACb,KAAK,IAAI,EACT,KAAK,OAAO,EAEZ,SAAS,EACT,UAAU,EACV,YAAY,EACZ,SAAS,EACT,SAAS,EACT,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,SAAS,GACf,CAAC"}

lib/string/index.js

@@ -6,3 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.titleCase = exports.snakeCase = exports.sentenceCase = exports.pascalCase = exports.camelCase = exports.uncapitalize = exports.split = exports.rsplit = exports.removeAccents = exports.parseNumber = exports.parseFunctionCall = exports.parseBool = exports.pad = exports.joinUrl = exports.joinNonEmpty = exports.join = exports.getCountDown = exports.formatTime = exports.formatStr = exports.center = exports.capitalize = exports.basicPluralizer = void 0;
+exports.titleCase = exports.snakeCase = exports.sentenceCase = exports.pascalCase = exports.camelCase = exports.uncapitalize = exports.split = exports.rsplit = exports.removeAccents = exports.plural = exports.parseNumber = exports.parseFunctionCall = exports.parseBool = exports.pad = exports.ordinal = exports.joinUrl = exports.joinNonEmpty = exports.join = exports.getCountDown = exports.formatTime = exports.formatStr = exports.center = exports.capitalize = void 0;
 const chalk_1 = __importDefault(require("chalk"));
@@ -14,2 +14,20 @@ const luxon_1 = require("luxon");
 /**
+ * Returns the ordinal of a number.
+ */
+const ordinal = (num) => {
+    const j = num % 10;
+    const k = num % 100;
+    if (j === 1 && k !== 11) {
+        return num + 'st';
+    }
+    if (j === 2 && k !== 12) {
+        return num + 'nd';
+    }
+    if (j === 3 && k !== 13) {
+        return num + 'rd';
+    }
+    return num + 'th';
+};
+exports.ordinal = ordinal;
+/**
  * Pluralizes the word if *quantity* is undefined or not 1. Uses the
@@ -20,13 +38,13 @@ * given plural or adds an 's' to the end.
  * // returns 'developers'
- * basicPluralizer('developer')
+ * plural('developer')
  * // returns 'developer'
- * basicPluralizer('developer', 1)
+ * plural('developer', 1)
  * // returns 'developers'
- * basicPluralizer('developer', 2)
+ * plural('developer', 2)
  */
-function basicPluralizer(word, quantity, plural) {
+const plural = (word, quantity, pluralVersion) => {
     const shouldPluralize = quantity === undefined || Math.abs(quantity) !== 1;
-    return shouldPluralize ? plural ?? `${word}s` : word;
-}
-exports.basicPluralizer = basicPluralizer;
+    return shouldPluralize ? pluralVersion ?? `${word}s` : word;
+};
+exports.plural = plural;
 /**
@@ -92,3 +110,3 @@ * Pads a string on both sides to achieve the desired length.
         parts: 2,
-        pluralize: basicPluralizer,
+        pluralize: plural,
         ...options,
@@ -167,3 +185,3 @@ };
         },
-        pluralize: basicPluralizer,
+        pluralize: plural,
         ...options,
@@ -170,0 +188,0 @@ };

package.json

 {
   "name": "@umatch/utils",
-  "version": "16.0.1",
+  "version": "17.0.0",
   "description": "Math, array, string, object & time-related functions and types.",
@@ -5,0 +5,0 @@ "author": "Gabriel Okamoto <[e-mail]>",

src/string/index.ts

@@ -12,3 +12,4 @@ import chalk, { type Chalk, type ForegroundColor } from 'chalk';
 type ChalkColor = typeof ForegroundColor;
-type Pluralizer = (word: string, quantity?: number, plural?: string) => string;
+type ToOrdinal = (num: number) => string;
+type ToPlural = (word: string, quantity?: number, plural?: string) => string;
 
@@ -52,2 +53,20 @@ /**
 /**
+ * Returns the ordinal of a number.
+ */
+const ordinal: ToOrdinal = (num: number): string => {
+  const j = num % 10;
+  const k = num % 100;
+  if (j === 1 && k !== 11) {
+    return num + 'st';
+  }
+  if (j === 2 && k !== 12) {
+    return num + 'nd';
+  }
+  if (j === 3 && k !== 13) {
+    return num + 'rd';
+  }
+  return num + 'th';
+};
+
+/**
  * Pluralizes the word if *quantity* is undefined or not 1. Uses the
@@ -58,12 +77,16 @@ * given plural or adds an 's' to the end.
  * // returns 'developers'
- * basicPluralizer('developer')
+ * plural('developer')
  * // returns 'developer'
- * basicPluralizer('developer', 1)
+ * plural('developer', 1)
  * // returns 'developers'
- * basicPluralizer('developer', 2)
+ * plural('developer', 2)
  */
-function basicPluralizer(word: string, quantity?: number, plural?: string): string {
+const plural: ToPlural = (
+  word: string,
+  quantity?: number,
+  pluralVersion?: string,
+): string => {
   const shouldPluralize = quantity === undefined || Math.abs(quantity) !== 1;
-  return shouldPluralize ? plural ?? `${word}s` : word;
-}
+  return shouldPluralize ? pluralVersion ?? `${word}s` : word;
+};
 
@@ -149,3 +172,3 @@ /**
     parts?: number;
-    pluralizer?: Pluralizer;
+    pluralizer?: ToPlural;
     short?: boolean;
@@ -157,3 +180,3 @@ },
     parts: 2,
-    pluralize: basicPluralizer,
+    pluralize: plural,
     ...options,
@@ -239,3 +262,3 @@ };
     dictionary?: DateTimeDict;
-    pluralizer?: Pluralizer;
+    pluralizer?: ToPlural;
     short?: boolean;
@@ -251,3 +274,3 @@ unitsThresholds?: readonly (readonly [DateTimeUnit, number])[];
     },
-    pluralize: basicPluralizer,
+    pluralize: plural,
     ...options,
@@ -754,3 +777,2 @@ };
 export {
-  basicPluralizer,
   capitalize,
@@ -764,2 +786,3 @@ center,
   joinUrl,
+  ordinal,
   pad,
@@ -769,2 +792,3 @@ parseBool,
   parseNumber,
+  plural,
   removeAccents,
@@ -777,4 +801,5 @@ rsplit,
   type LastLetter,
-  type Pluralizer,
   type Replace,
+  type ToOrdinal,
+  type ToPlural,
   type Trim,
@@ -781,0 +806,0 @@ type Unquote,

New alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

210482

0.38%

Lines of code

5262

0.9%

No dependency changes