@sveltebase/utils 1.0.3 → 1.0.4

package/README.md

@@ -18,14 +18,13 @@ bun add svelte-sonner
 
 > `svelte` is a peer dependency and should already exist in your app.
 
-## What’s included
-
 - `Cookies` — browser cookie helpers
 - `createAsync` — wraps async functions with loading and error state
 - `tryCatch` — run a task with built-in toast/error handling
 - `timestamps` — generate `createdAt` / `updatedAt` values
 - `wait` — simple promise-based delay helper
 - `createId` — generate random UUIDs with fallback support
+- `pluralize` — format counts using custom zero, one, and other rules
 - `TryCatchReturn` — shared return type for async helpers
 
 ## Exports
@@ -35,6 +34,7 @@ import {
   Cookies,
   createAsync,
   createId,
+  pluralize,
   timestamps,
   tryCatch,
   wait,
@@ -283,6 +283,37 @@ Useful for:
 
 ---
 
+## `pluralize`
+
+A helper for formatting counts into readable strings using custom rules for zero, one, and multiple items.
+
+### Example
+
+```ts
+import { pluralize } from "@sveltebase/utils";
+
+// 1. Basic usage
+pluralize(0, { other: "items" }); // "0 items"
+pluralize(1, { one: "item", other: "items" }); // "1 item"
+pluralize(5, { one: "item", other: "items" }); // "5 items"
+
+// 2. Custom zero text
+pluralize(0, { zero: "No items", one: "item", other: "items" }); // "No items"
+
+// 3. Callback formatting for complex pluralizations
+pluralize(3, {
+  other: (count) => `${count} matches found`
+}); // "3 matches found"
+```
+
+Useful for:
+
+- localized text formatting
+- user-facing list item counts (e.g., "1 item", "No items", "4 items")
+- dynamic messaging depending on numeric results
+
+---
+
 ## `TryCatchReturn`
 
 A shared type for functions used with `createAsync` and `tryCatch`.

package/dist/index.d.ts

@@ -23,4 +23,9 @@ export declare function tryCatch(task: () => Promise<TryCatchReturn> | TryCatchR
 export declare const wait: (ms: number) => Promise<unknown>;
 export { createAsync } from "./async.svelte.js";
 export declare function createId(): string;
+export declare function pluralize(count: number, { zero, one, other }: {
+    zero?: string;
+    one?: string;
+    other: string | ((count: number) => string);
+}): string;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IACrC,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAuCD,eAAO,MAAM,OAAO;cACR,MAAM,SAAS,MAAM,YAAW,aAAa,GAAQ,IAAI;cA6CzD,MAAM,GAAG,MAAM,GAAG,IAAI;iBAYnB,MAAM,YAAW,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,QAAQ,CAAC,GAAQ,IAAI;CAGjF,CAAC;AAEF,wBAAgB,UAAU,CAAC,CAAC,SAAS,OAAO,EAC1C,UAAU,EAAE,CAAC,GACZ,CAAC,SAAS,IAAI,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAInF;AAED,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,YAAY,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,wBAAsB,QAAQ,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc,iBAkBlF;AAED,eAAO,MAAM,IAAI,GAAI,IAAI,MAAM,qBAAsD,CAAC;AAEtF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,wBAAgB,QAAQ,IAAI,MAAM,CAgBjC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IACrC,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAuCD,eAAO,MAAM,OAAO;cACR,MAAM,SAAS,MAAM,YAAW,aAAa,GAAQ,IAAI;cA6CzD,MAAM,GAAG,MAAM,GAAG,IAAI;iBAYnB,MAAM,YAAW,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,QAAQ,CAAC,GAAQ,IAAI;CAGjF,CAAC;AAEF,wBAAgB,UAAU,CAAC,CAAC,SAAS,OAAO,EAC1C,UAAU,EAAE,CAAC,GACZ,CAAC,SAAS,IAAI,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAInF;AAED,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,YAAY,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,wBAAsB,QAAQ,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc,iBAkBlF;AAED,eAAO,MAAM,IAAI,GAAI,IAAI,MAAM,qBAAsD,CAAC;AAEtF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,wBAAgB,QAAQ,IAAI,MAAM,CAgBjC;AAED,wBAAgB,SAAS,CACvB,KAAK,EAAE,MAAM,EACb,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,CAAA;CAAE,UAOnG"}

package/dist/index.js

@@ -109,3 +109,12 @@ export function createId() {
         return v.toString(16);
     });
 }
+export function pluralize(count, { zero, one, other }) {
+    if (count === 0 && zero)
+        return zero;
+    if (count === 1 && one)
+        return `1 ${one}`;
+    if (typeof other === "function")
+        return other(count);
+    return `${count} ${other}`;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sveltebase/utils",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "type": "module",
   "publishConfig": {
     "access": "public"