shuffle-stream

Shuffle a stream

Usage no npm install needed!

<script type="module">
  import shuffleStream from 'https://cdn.skypack.dev/shuffle-stream';
</script>

README

shuffle-stream

Build Status

Shuffles a stream. Can shuffle in batches to reduce memory requirements. Uses the in-place Fisher-Yates algorithm for speed.

Usage


var shuffle = require('shuffle-stream')
  , opts = {
      // Optional, default false. Set to true if not
      // pushing buffers or strings.
      objectMode: false

      // Optional, default 0. When greater than zero, will
      // work in batches instead of buffering everything.
    , batchSize: 0
    }

readableStream.pipe(shuffle(opts)).pipe(writableStream)

License

The MIT License (MIT)

Copyright (c) 2014 Ben Ng

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.