JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 45650
  • Score
    100M100P100Q158867F
  • License MIT

Universal Module for Secure Random Generator in JavaScript

Package Exports

  • js-crypto-random
  • js-crypto-random/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (js-crypto-random) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Universal Module for Secure Random Generator in JavaScript

CircleCI

WARNING: At this time this solution should be considered suitable for research and experimentation, further code and security review is needed before utilization in a production application.

Introduction and Overview

This library is designed to be 'universal' as a random sequence generator, i.e., it works both on most browsers and on Node.js just by importing from npm/source code. Note that in the design principle, the library fully utilizes native APIs like WebCrypto API to accelerate its operation if available.

Installation

At your project directory, do either one of the following.

  • From npm/yarn:
    $ npm install --save js-crypto-random // npm
    $ yarn add js-crypto-random // yarn
  • From GitHub:
    $ git clone https://github.com/junkurihara/js-crypto-random.git

Then you should import the package as follows.

import random from 'js-crypto-random'; // for npm
import random from 'js-crypto-random/dist/index.js'; // for github

Usage

Generate random byte sequence

// now you get an Uint8Array of 32 bytes filled with randomly generated values
const randomBytes = random.getRandomBytes(32);

Generate random ascii sequence

// now you get a string of 32 ASCII characters generated in a cryptographically random manner
const randomAscii = random.getRandomAsciiString(32);

License

Licensed under the MIT license, see LICENSE file.