https://github.com/chakrit/randstream

Stream of random bytes.
https://github.com/chakrit/randstream

Last synced: about 20 hours ago
JSON representation

Stream of random bytes.

• Host: GitHub
• URL: https://github.com/chakrit/randstream
• Owner: chakrit
• Created: 2013-03-09T13:49:36.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-07-29T04:41:11.000Z (over 10 years ago)
• Last Synced: 2024-11-03T19:19:58.352Z (12 days ago)
• Language: JavaScript
• Homepage:
• Size: 188 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# RANDSTREAM

A stream that sprays out [random bytes][0] at whoever's `read()`-ing it or listening to

its `data`.  The implementation is surprisingly trivial thanks to

[isaacs/readable-stream][1] so I didn't have any tests but you should just take a good

look at the code if you are not sure.

# API

The exported `RandStream` class accepts a single option hash which is passed along as an

[option to the inherited `Readable` class][2] with an exception of a few extra parameters:

```js

var RandStream = require('randstream');

var firehose = new RandStream(

  { mode: 'alpha'

  , defaultSize: 4096

  });

firehose.pipe(process.stdout);

```

The `mode` option maybe one of the following value:

* `0` - A zero-filled streams. Essentially no longer random.

* `01` - A zero-one stream. Useful to use as test streams that is a bit less boring :p

* `random` - Default mode, using [`crypto.randomBytes`][0] to generate data. The buffer is

  then pushed any reading clients untouched.

* `pseudo` - Uses [`crypto.pseudoRandomBytes`][3] instead.

* `alpha` - A stream of lowercase alphabets. Useful if you want to see the bytes being

  piped. The original sequence is generated using [`crypto.randomBytes`][0].

* `num` - Like `alpha` but generate a stream of digits.

* `pregenerated` - Like `random` but reads from a random start position in a pregenerated

  buffer of data.

The `defaultSize` is the default size of the buffer to allocate when the underlying

`_read` implementation is not given a size.

# CLI

This module can also be used from the command line if you install globally with `-g`

```sh

$ npm install -g randstream

$ rand | hexdump -v

```

or with different mode and throttling rate:

```sh

$ rand alpha 16

mcrqijnorspunxrkkeyehapnpfgqfbkzjfvkctxfdkm^C

```

# LICENSE

public domain.

[0]: http://nodejs.org/api/crypto.html#crypto_crypto_randombytes_size_callback

[1]: https://github.com/isaacs/readable-stream

[2]: https://github.com/isaacs/readable-stream#new-streamreadableoptions

[3]: http://nodejs.org/api/crypto.html#crypto_crypto_pseudorandombytes_size_callback