mirror of
https://github.com/sablierapp/sablier.git
synced 2025-12-31 10:07:20 +01:00
docs(release): update doc version from 1.3.0-beta.1 to 1.3.0-beta.2 [skip ci]
This commit is contained in:
8
node_modules/from2/.travis.yml
generated
vendored
Normal file
8
node_modules/from2/.travis.yml
generated
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
language: node_js
|
||||
before_install:
|
||||
- npm install -g npm
|
||||
node_js:
|
||||
- "0.8"
|
||||
- "0.10"
|
||||
- "0.12"
|
||||
- "iojs"
|
||||
21
node_modules/from2/LICENSE.md
generated
vendored
Normal file
21
node_modules/from2/LICENSE.md
generated
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
## The MIT License (MIT) ##
|
||||
|
||||
Copyright (c) 2014 Hugh Kennedy
|
||||
|
||||
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.
|
||||
70
node_modules/from2/README.md
generated
vendored
Normal file
70
node_modules/from2/README.md
generated
vendored
Normal file
@@ -0,0 +1,70 @@
|
||||
# from2 [](https://flattr.com/submit/auto?user_id=hughskennedy&url=http://github.com/hughsk/from2&title=from2&description=hughsk/from2%20on%20GitHub&language=en_GB&tags=flattr,github,javascript&category=software)[](http://github.com/hughsk/stability-badges) #
|
||||
|
||||
`from2` is a high-level module for creating readable streams that properly handle backpressure.
|
||||
|
||||
Convience wrapper for
|
||||
[readable-stream](http://github.com/isaacs/readable-stream)'s `ReadableStream`
|
||||
base class, with an API lifted from
|
||||
[from](http://github.com/dominictarr/from) and
|
||||
[through2](http://github.com/rvagg/through2).
|
||||
|
||||
## Usage ##
|
||||
|
||||
[](https://nodei.co/npm/from2)
|
||||
|
||||
### `stream = from2([opts], read)` ###
|
||||
|
||||
Where `opts` are the options to pass on to the `ReadableStream` constructor,
|
||||
and `read(size, next)` is called when data is requested from the stream.
|
||||
|
||||
* `size` is the recommended amount of data (in bytes) to retrieve.
|
||||
* `next(err)` should be called when you're ready to emit more data.
|
||||
|
||||
For example, here's a readable stream that emits the contents of a given
|
||||
string:
|
||||
|
||||
``` javascript
|
||||
var from = require('from2')
|
||||
|
||||
function fromString(string) {
|
||||
return from(function(size, next) {
|
||||
// if there's no more content
|
||||
// left in the string, close the stream.
|
||||
if (string.length <= 0) return next(null, null)
|
||||
|
||||
// Pull in a new chunk of text,
|
||||
// removing it from the string.
|
||||
var chunk = string.slice(0, size)
|
||||
string = string.slice(size)
|
||||
|
||||
// Emit "chunk" from the stream.
|
||||
next(null, chunk)
|
||||
})
|
||||
}
|
||||
|
||||
// pipe "hello world" out
|
||||
// to stdout.
|
||||
fromString('hello world').pipe(process.stdout)
|
||||
```
|
||||
|
||||
### `stream = from2.obj([opts], read)` ###
|
||||
|
||||
Shorthand for `from2({ objectMode: true }, read)`.
|
||||
|
||||
### `createStream = from2.ctor([opts], read)` ###
|
||||
|
||||
If you're creating similar streams in quick succession you can improve
|
||||
performance by generating a stream **constructor** that you can reuse instead
|
||||
of creating one-off streams on each call.
|
||||
|
||||
Takes the same options as `from2`, instead returning a constructor which you
|
||||
can use to create new streams.
|
||||
|
||||
### See Also
|
||||
|
||||
- [from2-array](https://github.com/binocarlos/from2-array) - Create a from2 stream based on an array of source values.
|
||||
- [from2-string](https://github.com/yoshuawuyts/from2-string) - Create a stream from a string. Sugary wrapper around from2.
|
||||
|
||||
## License ##
|
||||
|
||||
MIT. See [LICENSE.md](http://github.com/hughsk/from2/blob/master/LICENSE.md) for details.
|
||||
Reference in New Issue
Block a user