Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

cb-buffer

2.1.9 • Public • Published

cb-buffer

cb-buffer

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

A minimalist NodeJS module for callback buffering.

☁️ Installation

# Using npm 
npm install --save cb-buffer
 
# Using yarn 
yarn add cb-buffer

📋 Example

// Dependencies
const CallbackBuffering = require("cb-buffer");
 
// Create a new callback buffer
var cb = new CallbackBuffering();
 
// Callbacks a random unique number after 1 sec
function getUniqueRandomNumberAsync(callback) {
    if (cb.check(callback)) { return; }
    setTimeout(() => {
        debugger
        cb.done(Math.random());
    }, 1000);
}
 
// Request the unique number few times.
// It should be unique, and generated once
getUniqueRandomNumberAsync(console.log);
getUniqueRandomNumberAsync(console.log);
getUniqueRandomNumberAsync(console.log);
getUniqueRandomNumberAsync(console.log);
// ... after one second
// => 0.3639475910458714
// => 0.3639475910458714
// => 0.3639475910458714
// => 0.3639475910458714
 
// After one second (after the random number is found)
// we request it again
setTimeout(() => {
    getUniqueRandomNumberAsync(console.log);
    // => 0.3639475910458714
}, 1000);

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. 🐛
  3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

CbBuffer()

Creates a new instance of CbBuffer.

The instance will contain methods documented below and the following fields:

  • buffer (Array): An array of functions to be called.
  • waiting (Boolean): A flag representing the state of the buffer.
  • is_done (Boolean): A flag representing the done state (is done or not).
  • args (Array): The callback function arguments.

Return

  • CbBuffer The CbBuffer instance.

check(fn)

Use this function to append the new function and return if needed:

if (cb.check(callback)) { return; }

Params

  • Function fn: The callback function.

Return

  • Boolean true if thw async function was called already.

call(fn)

Calls the provided function with the callback arguments.

Params

  • Function fn: The function to call.

clear()

CLears the callback array.

undone()

Resets the internal data.

done()

Calls all the functions from the buffer.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

  • image-parser
  • bible.js
  • cb-bufferify

📜 License

MIT © Ionică Bizău

Install

npm i cb-buffer

DownloadsWeekly Downloads

739

Version

2.1.9

License

MIT

Unpacked Size

11.6 kB

Total Files

4

Last publish

Collaborators

  • avatar
  • avatar
  • avatar