nanoid 5.1.0 → 5.1.1

package/index.browser.js

@@ -1,3 +1,4 @@
+/* @ts-self-types="./index.d.ts" */
 import { urlAlphabet as scopedUrlAlphabet } from './url-alphabet/index.js'
 export { urlAlphabet } from './url-alphabet/index.js'
 export let random = bytes => crypto.getRandomValues(new Uint8Array(bytes))

package/index.d.ts

@@ -10,7 +10,7 @@
  * ```
  *
  * @param size Size of the ID. The default size is 21.
- * @typeparam Type The type of the generated ID.
+ * @typeparam Type The ID type to replace `string` with some opaque type.
  * @returns A random string.
  */
 export function nanoid<Type extends string>(size?: number): Type
@@ -23,7 +23,7 @@ export function nanoid<Type extends string>(size?: number): Type
  *
  * @param alphabet Alphabet used to generate the ID.
  * @param defaultSize Size of the ID. The default size is 21.
- * @typeparam Type The type of the generated ID.
+ * @typeparam Type The ID type to replace `string` with some opaque type.
  * @returns A random string generator.
  *
  * ```js
@@ -60,7 +60,7 @@ export function customAlphabet<Type extends string>(
  * @param alphabet Alphabet used to generate a random string.
  * @param size Size of the random string.
  * @param random A random bytes generator.
- * @typeparam Type The type of the generated ID.
+ * @typeparam Type The ID type to replace `string` with some opaque type.
  * @returns A random string generator.
  */
 export function customRandom<Type extends string>(

package/non-secure/index.d.ts

@@ -8,9 +8,10 @@
  * ```
  *
  * @param size Size of the ID. The default size is 21.
+ * @typeparam Type The ID type to replace `string` with some opaque type.
  * @returns A random string.
  */
-export function nanoid(size?: number): string
+export function nanoid<Type extends string>(size?: number): Type
 
 /**
  * Generate a unique ID based on a custom alphabet.
@@ -19,15 +20,16 @@ export function nanoid(size?: number): string
  *
  * @param alphabet Alphabet used to generate the ID.
  * @param defaultSize Size of the ID. The default size is 21.
+ * @typeparam Type The ID type to replace `string` with some opaque type.
  * @returns A random string generator.
  *
  * ```js
  * import { customAlphabet } from 'nanoid/non-secure'
  * const nanoid = customAlphabet('0123456789абвгдеё', 5)
- * model.id = //=> "8ё56а"
+ * model.id = nanoid() //=> "8ё56а"
  * ```
  */
-export function customAlphabet(
+export function customAlphabet<Type extends string>(
   alphabet: string,
   defaultSize?: number
-): (size?: number) => string
+): (size?: number) => Type

package/non-secure/index.js

@@ -1,3 +1,16 @@
+/* @ts-self-types="./index.d.ts" */
+/**
+ * By default, Nano ID uses hardware random bytes generation for security
+ * and low collision probability. If you are not so concerned with security,
+ * you can use it for environments without hardware random generators.
+ *
+ * ```js
+ * import { nanoid } from 'nanoid/non-secure'
+ * const id = nanoid()
+ * ```
+ *
+ * @module
+ */
 let urlAlphabet =
   'useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict'
 export let customAlphabet = (alphabet, defaultSize = 21) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nanoid",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "description": "A tiny (118 bytes), secure URL-friendly unique string ID generator",
   "keywords": [
     "uuid",