cqu

cqueue

Channel queue with Promises

Showing:

Popularity

Downloads/wk

0

GitHub Stars

0

Maintenance

Last Commit

6yrs ago

Contributors

1

Package

Dependencies

1

License

BSD-3-Clause

Type Definitions

Tree-Shakeable

No?

Categories

Readme

cqueue

cqueue is a Channel queue for holding a msg/value until it's taken. Promises are used for concurrent operations against the queue.

build status

How do I use it?

Put something in the queue, and then take it at some point in the future. The queue can only hold one value, and the response will indicate what your machine should do, i.e. "continue" or "pause".

const cqueue = require("cqueue");
let chan = cqueue();

function handle (arg) {
    console.log(arg[1] || "empty");
}

chan.take().then(handle); // "empty"
chan.put("hello world");
chan.take().then(handle); // "hello world"

API

queue

Property

Array which can hold 1 value

put

Method

Puts an item into the Channel, and the Promise receives an Array

method put param {Mixed} arg Item return {Object} Promise

chan.put(arg).then(function(state) {
    if (state[0] === "continue") {
        // arg was added to the channel
    } else {
        // arg is not in the channel
    }
});

take

Method

Takes an item from the Channel, and the Promise receives an Array

method take

return {Object} Promise

chan.take().then(function(state) {
    if (state[0] === "continue") {
        // state[1] was taken from the channel
    } else {
        // state[1] is null
    }
});

License

Copyright (c) 2015 Jason Mulligan Licensed under the BSD-3 license.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial