nanoid

# Nano ID

<img src="https://ai.github.io/nanoid/logo.svg" align="right"
     alt="Nano ID logo by Anton Lovchikov" width="180" height="94">

**English** | [日本語](./README.ja.md) | [Русский](./README.ru.md) | [简体中文](./README.zh-CN.md) | [Bahasa Indonesia](./README.id-ID.md) | [한국어](./README.ko.md) | [العربية](./README.ar.md)

A tiny, secure, URL-friendly, unique string ID generator for JavaScript.

> “An amazing level of senseless perfectionism,
> which is simply impossible not to respect.”

- **Small.** 117 bytes (minified and brotlied). No dependencies.
  [Size Limit] controls the size.
- **Fast.** Faster than native `crypto.randomUUID()`.
- **Safe.** It uses hardware random generator. Can be used in clusters.
- **Short IDs.** It uses a larger alphabet than UUID (`A-Za-z0-9_-`).
  So ID size was reduced from 36 to 21 symbols.
- **Portable.** Nano ID was ported
  to over [20 programming languages](./README.md#other-programming-languages).

```js
import { nanoid } from 'nanoid'
model.id = nanoid() //=> "V1StGXR8_Z5jdHi6B-myT"
```

---

<img src="https://cdn.evilmartians.com/badges/logo-no-label.svg" alt="" width="22" height="16" />  Nano ID is built by <b><a href="https://evilmartians.com/">Evil Martians</a></b>, an American design and engineering consultancy for <b>developer tools, AI, and cybersecurity startups</b>.

---

[Size Limit]: https://github.com/ai/size-limit

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Comparison with UUID](#comparison-with-uuid)
- [Benchmark](#benchmark)
- [Security](#security)
- [Install](#install)
  - [CDN](#cdn)
- [API](#api)
  - [Custom Alphabet or Size](#custom-alphabet-or-size)
  - [Custom Random Bytes Generator](#custom-random-bytes-generator)
  - [Non-Secure](#non-secure)
- [Usage](#usage)
  - [React](#react)
  - [React Native](#react-native)
  - [PouchDB and CouchDB](#pouchdb-and-couchdb)
  - [CLI](#cli)
  - [TypeScript](#typescript)
  - [Other Programming Languages](#other-programming-languages)
- [Tools](#tools)

## Comparison with UUID

Nano ID is quite comparable to UUID v4 (random-based).
It has a similar number of random bits in the ID
(126 in Nano ID and 122 in UUID), so it has a similar collision probability:

> For there to be a one in a billion chance of duplication,
> 103 trillion version 4 IDs must be generated.

There are two main differences between Nano ID and UUID v4:

1. Nano ID uses a bigger alphabet, so a similar number of random bits
   are packed in just 21 symbols instead of 36.
2. Nano ID is faster than `crypto.randomUUID` and `uuid/v4`.

## Benchmark

```rust
$ node ./test/benchmark.js
nope-id                 50,866,431 ops/sec
nanoid                  25,580,859 ops/sec
customAlphabet           3,955,574 ops/sec
crypto.randomUUID        6,583,303 ops/sec
uuid v4                  5,575,055 ops/sec
@napi-rs/uuid            8,369,981 ops/sec
uid/secure               7,965,602 ops/sec
@lukeed/uuid             6,301,692 ops/sec
nanoid for browser         626,943 ops/s