How to use nanoid module on NodeJS?

Using the nanoid module in Node.js can generate unique, secure, and URL-friendly identifiers. Here are the detailed steps to use this module in a Node.js application:

Step 1: Installing nanoid

First, install the nanoid module in your Node.js project. You can install it using npm or yarn. Run one of the following commands in your terminal or command line tool:

bash
npm install nanoid

or

bash
yarn add nanoid

Step 2: Importing the nanoid module

In the file where you need to generate IDs, import the nanoid module. Use the require or ES6 import statement to do so:

javascript
// Using CommonJS module system
const { nanoid } = require('nanoid');

// Or using ES6 module import
import { nanoid } from 'nanoid';

Step 3: Generating an ID with nanoid

Now you can use the nanoid() function to generate a unique ID. This function can be called directly and returns a new random ID string. For example:

javascript
const id = nanoid();
console.log(id); // Outputs a string like 'V1StGXR8_Z5jdHi6B-myT'

Step 4: Customizing the ID Length

By default, nanoid generates IDs of 21 characters. If you need IDs of a different length, pass the desired length as a parameter to the nanoid() function:

javascript
const customLengthId = nanoid(10); // Generates an ID of length 10
console.log(customLengthId);

Example: Generating Order Numbers in an E-commerce System

Consider an e-commerce system where, whenever a user places an order, we need to generate a unique order number. Using nanoid, we can easily achieve this:

javascript
import { nanoid } from 'nanoid';

function createOrder(product, user) {
    const orderId = nanoid();
    const order = {
        id: orderId,
        product: product,
        user: user,
        date: new Date()
    };
    return order;
}

// Example usage
const order = createOrder({ name: 'Book', price: 39.99 }, { name: 'Zhang San' });
console.log('Order generated:', order);

Conclusion

Using nanoid to generate IDs in Node.js is a very simple and straightforward process. This module not only provides high security and performance but also has a simple and easy-to-use API. Whether for database record identifiers, order numbers, or any scenario requiring uniqueness, nanoid is an excellent choice.