zimgao/gochan
1
0
Fork 0
Code Issues Pull requests Packages Wiki Activity Actions

README & API.md: minor edits

Browse source
This commit is contained in:
David Braun 2017-10-23 11:46:08 -04:00
parent 9c18fc7055
commit 2209c0ea76
No known key found for this signature in database
GPG key ID: 5694EEC4D129BDCF
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -10,10 +10,10 @@ already know most of how to use a `Channel`.
Go's use of channels for concurrency is amazing and with JavaScript's
async/await feature we have the basis for it as well. All that's missing is a
solid `Channel` type. There are existing libraries but I wanted an idiomatic
`Channel` type that's more simple and minimally-opinionated.
`Channel` type that's simple and minimally-opinionated.
This document assumes you're familiar with Go's channels and why you'd want to
use them. For explanatory background, read my [blog
use them. For explanatory background, see my [blog
article](https://www.nodeguy.com/channels-for-javascript/) on the subject.
## Requirements

2
doc/API.md
View file

@ -152,7 +152,7 @@ These properties are similar to the equivalently named properties of `Array`.
## Channel
### Channel([bufferLength = 0]) -> Channel
### Channel([bufferLength]) -> Channel
Create a new `Channel` with an optional buffer. This allows an async function
to push up to `bufferLength` values before blocking.