-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add it-byte-stream, it-length-prefixed-stream and it-protobuf-s…
…tream Add modules designed to make working with streams easier.
- Loading branch information
1 parent
cc96001
commit 8271623
Showing
31 changed files
with
1,700 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| This project is dual licensed under MIT and Apache-2.0. | ||
|
|
||
| MIT: https://www.opensource.org/licenses/mit | ||
| Apache-2.0: https://www.apache.org/licenses/license-2.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| The MIT License (MIT) | ||
|
|
||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # it-byte-stream <!-- omit in toc --> | ||
|
|
||
| [](https://codecov.io/gh/achingbrain/it) | ||
| [](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amaster) | ||
|
|
||
| > Read and write arbitrary bytes over a duplex stream | ||
| ## Table of contents <!-- omit in toc --> | ||
|
|
||
| - [Install](#install) | ||
| - [Browser `<script>` tag](#browser-script-tag) | ||
| - [Usage](#usage) | ||
| - [License](#license) | ||
| - [Contribution](#contribution) | ||
|
|
||
| ## Install | ||
|
|
||
| ```console | ||
| $ npm i it-byte-stream | ||
| ``` | ||
|
|
||
| ### Browser `<script>` tag | ||
|
|
||
| Loading this module through a script tag will make it's exports available as `ItByteStream` in the global namespace. | ||
|
|
||
| ```html | ||
| <script src="https://unpkg.com/it-byte-stream/dist/index.min.js"></script> | ||
| ``` | ||
|
|
||
| - [Install](#install) | ||
| - [Browser `<script>` tag](#browser-script-tag) | ||
| - [Usage](#usage) | ||
| - [License](#license) | ||
| - [Contribution](#contribution) | ||
|
|
||
| ```sh | ||
| > npm install it-pb-stream | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```js | ||
| import { byteStream } from 'it-byte-stream' | ||
|
|
||
| const stream = byteStream(duplex) | ||
|
|
||
| // read next available chunk | ||
| await stream.read() | ||
|
|
||
| // read next 5 bytes only | ||
| await stream.read(5) | ||
|
|
||
| // write a Uint8Array | ||
| await stream.write(buf) | ||
|
|
||
| //.. etc | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Licensed under either of | ||
|
|
||
| - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>) | ||
| - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>) | ||
|
|
||
| ## Contribution | ||
|
|
||
| Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| { | ||
| "name": "it-byte-stream", | ||
| "version": "0.0.0", | ||
| "description": "Read and write arbitrary bytes over a duplex stream", | ||
| "author": "Alex Potsides <alex@achingbrain.net>", | ||
| "license": "Apache-2.0 OR MIT", | ||
| "homepage": "https://github.com/achingbrain/it/tree/master/packages/it-byte-stream#readme", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/achingbrain/it.git" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/achingbrain/it/issues" | ||
| }, | ||
| "type": "module", | ||
| "types": "./dist/src/index.d.ts", | ||
| "files": [ | ||
| "src", | ||
| "dist", | ||
| "!dist/test", | ||
| "!**/*.tsbuildinfo" | ||
| ], | ||
| "exports": { | ||
| ".": { | ||
| "types": "./dist/src/index.d.ts", | ||
| "import": "./dist/src/index.js" | ||
| } | ||
| }, | ||
| "eslintConfig": { | ||
| "extends": "ipfs", | ||
| "parserOptions": { | ||
| "sourceType": "module" | ||
| } | ||
| }, | ||
| "release": { | ||
| "branches": [ | ||
| "master" | ||
| ], | ||
| "plugins": [ | ||
| [ | ||
| "@semantic-release/commit-analyzer", | ||
| { | ||
| "preset": "conventionalcommits", | ||
| "releaseRules": [ | ||
| { | ||
| "breaking": true, | ||
| "release": "major" | ||
| }, | ||
| { | ||
| "revert": true, | ||
| "release": "patch" | ||
| }, | ||
| { | ||
| "type": "feat", | ||
| "release": "minor" | ||
| }, | ||
| { | ||
| "type": "fix", | ||
| "release": "patch" | ||
| }, | ||
| { | ||
| "type": "docs", | ||
| "release": "patch" | ||
| }, | ||
| { | ||
| "type": "test", | ||
| "release": "patch" | ||
| }, | ||
| { | ||
| "type": "deps", | ||
| "release": "patch" | ||
| }, | ||
| { | ||
| "scope": "no-release", | ||
| "release": false | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| [ | ||
| "@semantic-release/release-notes-generator", | ||
| { | ||
| "preset": "conventionalcommits", | ||
| "presetConfig": { | ||
| "types": [ | ||
| { | ||
| "type": "feat", | ||
| "section": "Features" | ||
| }, | ||
| { | ||
| "type": "fix", | ||
| "section": "Bug Fixes" | ||
| }, | ||
| { | ||
| "type": "chore", | ||
| "section": "Trivial Changes" | ||
| }, | ||
| { | ||
| "type": "docs", | ||
| "section": "Documentation" | ||
| }, | ||
| { | ||
| "type": "deps", | ||
| "section": "Dependencies" | ||
| }, | ||
| { | ||
| "type": "test", | ||
| "section": "Tests" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ], | ||
| "@semantic-release/changelog", | ||
| "@semantic-release/npm", | ||
| "@semantic-release/github", | ||
| "@semantic-release/git" | ||
| ] | ||
| }, | ||
| "scripts": { | ||
| "build": "aegir build", | ||
| "lint": "aegir lint", | ||
| "dep-check": "aegir dep-check", | ||
| "clean": "aegir clean", | ||
| "test": "aegir test", | ||
| "test:node": "aegir test -t node --cov", | ||
| "test:chrome": "aegir test -t browser --cov", | ||
| "test:chrome-webworker": "aegir test -t webworker", | ||
| "test:firefox": "aegir test -t browser -- --browser firefox", | ||
| "test:firefox-webworker": "aegir test -t webworker -- --browser firefox", | ||
| "release": "aegir release" | ||
| }, | ||
| "dependencies": { | ||
| "it-pushable": "^3.2.0", | ||
| "it-stream-types": "^2.0.1", | ||
| "uint8arraylist": "^2.4.1" | ||
| }, | ||
| "devDependencies": { | ||
| "aegir": "^39.0.2", | ||
| "it-pair": "^2.0.2", | ||
| "uint8arrays": "^4.0.2" | ||
| } | ||
| } |
Oops, something went wrong.