Sourced from nanoid's releases.

3.0 Migration Guide

Nano ID 3.0 is the biggest release in the project history. Unfortunately, you will need to change the code of your application. But the changes are very small in most cases. In return, you will have better performance, smaller size, ES modules and TypeScript support.

Known Issues

• Create React App needs to merge this pull request to fix dual ESM/CJS packages. Do not migrate to 3.0 if you use CRA with TypeScript.

Simple Case

In simple cases, you just need to change default import to named import.

- import nanoid from 'nanoid'
+ import { nanoid } from 'nanoid'
nanoid() //=> "sSAi9F8yakJZPxOCr_WFb"
nanoid(5) //=> "ISe9l"

If you support IE, you need to transpile node_modules by Babel.

Non-secure and asynchronous Nano ID need only import changes as well.

- import nanoid from 'nanoid/non-secure'
+ import { nanoid } from 'nanoid/non-secure'
nanoid() //=> "sSAi9F8yakJZPxOCr_WFb"

- import nanoid from 'nanoid/async'
+ import { nanoid } from 'nanoid/async'
nanoid().then(id => {
id //=> "sSAi9F8yakJZPxOCr_WFb"
})

TypeScript

Remove @types/nanoid if you have it. Nano ID now have built-in types.

npm uninstall @types/nanoid

React Native

For Expo you need to load the file by direct path:

... (truncated)

Sourced from nanoid's changelog.

3.1.12

• Improve IE 11 docs.

3.1.11

• Fixed asynchronous customAlphabet in browser (by @LoneRifle).

3.1.10

• Fix ES modules support.

3.1.9

• Try to fix React Native Expo support.

3.1.8

• Add React Native Expo support.

3.1.7

• Clean up code.

3.1.6

• Avoid self using.

3.1.5

• Improve IE docs and warning.

3.1.4

• Restrict old Node.js 13 by engines.node (by Cansin Yildiz).

3.1.3

• Fix ES modules issue with CLI.

3.1.2

• Add shebang to CLI.

3.1.1

• Fix CLI.

3.1

• Add npx nanoid CLI.

3.0.2

• Fix docs (by Dylan Irlbeck ).

3.0.1

• Fix React Native warning on non-secure import (by Jia Huang).

3.0

Migration guide: https://github.com/ai/nanoid/releases/tag/3.0.0

• Move to ES2016 syntax. You need to use Babel for IE 11.
• Move to named exports import { nanoid } from 'nanoid'.
• Move import url from 'nanoid/url' to import { urlAlphabet } from 'nanoid'.

... (truncated)

• d5def1a Release 3.1.12 version
• ae0fbea Update dependencies
• 2ec4ea7 Improve IE 11 help
• e542e36 Release 3.1.11 version
• b60596a Update size limit
• 5a57e02 Update dependencies
• 1530b7d async/customAlphabet - ensure browser version returns Promise (#229)
• 5282c5a Update dependencies
• 908197c Replace kleur to colorette
• 8e7b9c2 Update dependencies
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)