Wondering what’s next for npm?Check out our public roadmap! »

    bucket-array

    0.0.5 • Public • Published

    Bucket

    This is a simple JavaScript cache buffer aka Bucket

    Installation

    $ component install PetroFeed/bucket
    
    $ npm install bucket-array
    

    API

    var Bucket = require('bucket')
      , bucket = new Bucket(4);
     
    bucket.on('progress', function(progress){
     
    });
     
    bucket.on('full', function(data){
        // our bucket is full so now do something
    });
     
    ["amy", "candace", "lindsey", "melanie"].forEach(function(data){
      bucket.push(data);
    });
     
    // reset and return buffer 
    bucket.empty();
     
    // reset buffer
    bucket.kick();

    Progress events

    { 
      index: 1,
      pending: 2,
      total: 3,
    }

    End events

    Contain the buffer data.

    { 
      buffer: ["amy", "candace", "lindsey"],
    }

    License

    MIT Licensed

    Copyright 2013 PetroFeed Inc.

    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.

    Keywords

    none

    Install

    npm i bucket-array

    DownloadsWeekly Downloads

    3

    Version

    0.0.5

    License

    none

    Last publish

    Collaborators

    • avatar