2.0.2 • Published 7 years ago

randombins v2.0.2

Weekly downloads
14
License
SEE LICENSE IN LI...
Repository
github
Last release
7 years ago

randombins Join the chat at https://gitter.im/ZenyWay/randombins

NPM build status coverage status Dependency Status

generate cryptographically-secure random shuffled bins of string combinations.

example

import getRandomBins from 'randombins'
const randombins = getRandomBins({ size: 8 }) // default length is 256 bins

import debug = require('debug')
debug.enable('randombins:*')

const alphabets = [ '0123', 'abcd', 'ABCD' ] // 4*4*4 = 64 combinations

randombins(alphabets)
.forEach(debug('randombins:')) // e.g. 0aA, 0aC, 1aA, 1cB, 2bA, 2bD, 3aA, 3dA
.catch(debug('randombins:error:'))

a live version of this example can be viewed here in the browser console, or by cloning this repository and running the following commands from a terminal:

npm install
npm run example

the files of this example are available here.

API v2.0 stable

ES5 and Typescript compatible. coded in Typescript 2, transpiled to ES5.

for a detailed specification of the API, run the unit tests in your browser.

CONTRIBUTING

see the contribution guidelines

LICENSE

Copyright 2017 Stéphane M. Catala

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and Limitations under the License.