ldiamond/strom
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Sami Turcotte 2018-12-07 22:33:42 -05:00 committed by GitHub
parent 3776d41ccd
commit 002e9b7bb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -104,6 +104,8 @@ Return a `ReadWrite` stream that splits streamed chunks using the given separato
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| `separator` | `string` | Separator to split by, defaulting to `"\n"` | | `separator` | `string` | Separator to split by, defaulting to `"\n"` |
| `options` | `object` | |
| `options.encoding` | `string` | Character encoding to use for decoding chunks. Defaults to utf8
```js ```js
Mhysa.fromArray(["a,b", "c,d"]) Mhysa.fromArray(["a,b", "c,d"])
@ -120,6 +122,8 @@ Return a `ReadWrite` stream that joins streamed chunks using the given separator
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| `separator` | `string` | Separator to join with | | `separator` | `string` | Separator to join with |
| `options` | `object` | |
| `options.encoding` | `string` | Character encoding to use for decoding chunks. Defaults to utf8
```js ```js
Mhysa.fromArray(["a", "b", "c"]) Mhysa.fromArray(["a", "b", "c"])
@ -135,8 +139,10 @@ the streamed chunks with the specified replacement string
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| `searchValue` | `string | RegExp` | Search string to use | | `searchValue` | `string \| RegExp` | Search string to use |
| `replaceValue` | `string` | Replacement string to use | | `replaceValue` | `string` | Replacement string to use |
| `options` | `object` | |
| `options.encoding` | `string` | Character encoding to use for decoding chunks. Defaults to utf8
```js ```js
Mhysa.fromArray(["a1", "b22", "c333"]) Mhysa.fromArray(["a1", "b22", "c333"])