randomstring

What is randomstring?

The randomstring npm package is a utility for generating random strings. It is useful for creating random identifiers, tokens, passwords, and other strings where randomness is required.

What are randomstring's main functionalities?

Generate a random string of a specified length

This feature allows you to generate a random string of a specified length. In this example, a random string of 12 characters is generated.

const randomstring = require('randomstring');
const str = randomstring.generate(12);
console.log(str);

Generate a random string with specific character set

This feature allows you to generate a random string using a specific set of characters. In this example, a random string of 8 alphabetic characters is generated.

const randomstring = require('randomstring');
const str = randomstring.generate({
  length: 8,
  charset: 'alphabetic'
});
console.log(str);

Generate a random string with custom characters

This feature allows you to generate a random string using a custom set of characters. In this example, a random string of 10 characters is generated using the characters 'a', 'b', 'c', '1', '2', and '3'.

const randomstring = require('randomstring');
const str = randomstring.generate({
  length: 10,
  charset: 'abc123'
});
console.log(str);

Other packages similar to randomstring

uuid

The uuid package is used to generate RFC-compliant UUIDs (Universally Unique Identifiers). While it is more focused on generating unique identifiers rather than random strings, it serves a similar purpose in providing unique values.

crypto-random-string

The crypto-random-string package generates cryptographically strong random strings. It is similar to randomstring but focuses on providing higher security by using the Node.js crypto module.

nanoid

The nanoid package is a small, secure, URL-friendly, unique string ID generator. It is similar to randomstring but emphasizes security and efficiency, making it suitable for generating unique IDs in web applications.

README

node-randomstring

Library to help you create random strings.

Installation

To install randomstring, use npm:

npm install randomstring

Usage

var randomstring = require("randomstring");

randomstring.generate();
// >> "XwPp9xazJ0ku5CZnlmgAx2Dld8SHkAeT"

randomstring.generate(7);
// >> "xqm5wXX"

randomstring.generate({
  length: 12,
  charset: 'alphabetic'
});
// >> "AqoTIzKurxJi"

randomstring.generate({
  charset: 'abc'
});
// >> "accbaabbbbcccbccccaacacbbcbbcbbc"

randomstring.generate({
  charset: ['numeric', '!']
});
// >> "145132!87663611567!2486211!07856"

randomstring.generate({
  charset: 'abc'
}, cb);
// >> "cb(generatedString) {}"

API

randomstring.

• generate(options, cb)
  • options
    • length - the length of the random string. (default: 32) [OPTIONAL]
    • readable - exclude poorly readable chars: 0OIl. (default: false) [OPTIONAL]
    • charset - define the character set for the string. (default: 'alphanumeric') [OPTIONAL]
      • alphanumeric - [0-9 a-z A-Z]
      • alphabetic - [a-z A-Z]
      • numeric - [0-9]
      • hex - [0-9 a-f]
      • binary - [01]
      • octal - [0-7]
      • custom - any given characters
      • [] - An array of any above
    • capitalization - define whether the output should be lowercase / uppercase only. (default: null) [OPTIONAL]
      • lowercase
      • uppercase
  • cb - Optional. If provided uses async version of crypto.randombytes

Command Line Usage

$ npm install -g randomstring

$ randomstring
> sKCx49VgtHZ59bJOTLcU0Gr06ogUnDJi

$ randomstring 7
> CpMg433

$ randomstring length=24 charset=github readable
> hthbtgiguihgbuttuutubugg

Tests

npm install
npm test

LICENSE

node-randomstring is licensed under the MIT license.