@marianmeres/uid 1.0.0 → 1.1.0

package/dist/mod.d.ts

@@ -6,10 +6,14 @@
  * keep its word lists out of the core bundle.
  *
  * @example
+ * ```ts
  * import { uid, nanoid, uuidv7 } from "@marianmeres/uid";
  * uid();                         // uuid v4
  * nanoid(12);                    // tree-shakeable named export
  * uid("uuidv7");                 // sortable database key
+ * ```
+ *
+ * @module
  */
 export * from "./random.js";
 export * from "./uuid.js";

package/dist/mod.js

@@ -6,10 +6,14 @@
  * keep its word lists out of the core bundle.
  *
  * @example
+ * ```ts
  * import { uid, nanoid, uuidv7 } from "@marianmeres/uid";
  * uid();                         // uuid v4
  * nanoid(12);                    // tree-shakeable named export
  * uid("uuidv7");                 // sortable database key
+ * ```
+ *
+ * @module
  */
 export * from "./random.js";
 export * from "./uuid.js";

package/dist/rhr.d.ts

@@ -14,6 +14,8 @@
  * import { rhr } from "@marianmeres/uid/rhr";
  * rhr({ nounsCount: 1 });
  * ```
+ *
+ * @module
  */
 import { type RhrOptions } from "./uid.js";
 /**

package/dist/rhr.js

@@ -14,6 +14,8 @@
  * import { rhr } from "@marianmeres/uid/rhr";
  * rhr({ nounsCount: 1 });
  * ```
+ *
+ * @module
  */
 import { getRandomHumanReadable } from "@marianmeres/random-human-readable";
 import { registerStrategy } from "./uid.js";

package/dist/uid.d.ts

@@ -61,13 +61,21 @@ export interface ReversibleOptions {
  * subset of `@marianmeres/random-human-readable` options that yield a string.
  */
 export interface RhrOptions {
+    /** Number of adjectives (default: 1). */
     adjCount?: number;
+    /** Number of color names (default: 1). */
     colorsCount?: number;
+    /** Number of nouns (default: 2). */
     nounsCount?: number;
+    /** Number of nonsense CV syllables to append (default: 0). */
     syllablesCount?: number;
+    /** Number of random digits to append (default: 0). */
     digitsCount?: number;
+    /** Number of special characters to append (default: 0). */
     specialCharsCount?: number;
+    /** Randomize letter casing (default: false). */
     randomizeCase?: boolean;
+    /** Separator between parts (default: "-"). */
     joinWith?: string;
 }
 /** A strategy implementation: takes its options object, returns a string. */
@@ -80,14 +88,25 @@ export type StrategyFn = (options?: Record<string, unknown>) => string;
 export declare function registerStrategy(name: string, fn: StrategyFn): void;
 /** Returns the names of all currently registered strategies. */
 export declare function listStrategies(): string[];
+/** Generates a UUID v4 — the default strategy. */
 export declare function uid(strategy?: "uuid" | "uuidv4", options?: UuidOptions): string;
+/** Generates a time-sortable UUID v7. */
 export declare function uid(strategy: "uuidv7", options?: Uuidv7Options): string;
+/** Generates a time-sortable ULID (Crockford base32). */
 export declare function uid(strategy: "ulid", options?: UlidOptions): string;
+/** Generates a random base56 string, or reversibly encodes `options.uuid`. */
 export declare function uid(strategy: "base56", options?: Base56Options): string;
+/** Generates a URL-safe nanoid-style id. */
 export declare function uid(strategy: "nanoid", options?: NanoidOptions): string;
+/** Generates a random string over a named alphabet. */
 export declare function uid(strategy: "hex" | "base32" | "base36" | "base58" | "base62" | "numeric", options?: AlphabetOptions): string;
+/** Generates a random string over a custom `options.alphabet`. */
 export declare function uid(strategy: "custom", options: CustomOptions): string;
+/** Returns the next value of an in-memory, per-prefix counter. */
 export declare function uid(strategy: "counter", options?: CounterOptions): string;
+/** Reversibly encodes `options.value` into a short string. */
 export declare function uid(strategy: "reversible", options: ReversibleOptions): string;
+/** Generates a human-readable id (requires `import "@marianmeres/uid/rhr"`). */
 export declare function uid(strategy: "rhr", options?: RhrOptions): string;
+/** Generates an id using any registered strategy, looked up by name. */
 export declare function uid(strategy: string, options?: Record<string, unknown>): string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@marianmeres/uid",
-	"version": "1.0.0",
+	"version": "1.1.0",
 	"type": "module",
 	"main": "dist/mod.js",
 	"types": "dist/mod.d.ts",