Need help with node-randomstring?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

klughammer
462 Stars 70 Forks MIT License 91 Commits 1 Opened issues

Description

A node.js module for generating random strings

Services available

!
?

Need anything else?

Contributors list

node-randomstring

Build Status Download Stats

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: '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
    • 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.