Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qard/channel-surfer
Promise-based CSP channels, with async iterator support.
https://github.com/qard/channel-surfer
async-await async-iterators csp-channels nodejs promise
Last synced: 3 months ago
JSON representation
Promise-based CSP channels, with async iterator support.
- Host: GitHub
- URL: https://github.com/qard/channel-surfer
- Owner: Qard
- Created: 2017-08-27T10:02:38.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-06T03:32:38.000Z (over 5 years ago)
- Last Synced: 2024-10-15T08:33:47.567Z (3 months ago)
- Topics: async-await, async-iterators, csp-channels, nodejs, promise
- Language: JavaScript
- Homepage:
- Size: 13.7 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# channel-surfer
Promise-based CSP channels, with async iterator support.
## Install
```sh
npm install channel-surfer
```
## Usage
```js
const Channel = require('channel-surfer')
const chan = new Channel()
// Consume with a simple `for await` loop
async function asyncAwaitConsumer() {
for await (let message of chan) {
console.log('received', message)
}
}
// Or use the underlying promises with `channel.next()`
function manualConsumer () {
channel.next().then(message => {
console.log('received', message)
}).then(manualConsumer)
}
setInterval(() => {
chan.give('hello')
}, 100)
```
## API
### new Channel(): Channel
Create a new channel
```js
const channel = new Channel()
```
### channel.give(value: any): void
Give a value to the channel.
```js
channel.give('hello')
```
### channel.next(): Promise>
Receive a value from the channel. Note that the final item in the channel will cycle to itself, so further calls to this method will continue to return the final item.
```js
channel.next() // { done: false, value: 'hello' }
```
### channel.close(): void
Close the channel to indicate no more values will be sent. This is required for a `for await` loop to complete.
```js
channel.close()
```
### channel.error(error: any): void
Send an error to the channel and then close it.
```js
channel.error(new Error('oh no!'))
```
### channel.giveBack(value: any): void
Put a value at the top of the queue, to be received by the next request.
```js
channel.giveBack('hello')
```
---
### Copyright (c) 2019 Stephen Belanger
#### Licensed under MIT License
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.