Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Borewit/tokenizer-http
Fetch HTTP streamed chunks using RFC-7233 range requests
https://github.com/Borewit/tokenizer-http
Last synced: 9 days ago
JSON representation
Fetch HTTP streamed chunks using RFC-7233 range requests
- Host: GitHub
- URL: https://github.com/Borewit/tokenizer-http
- Owner: Borewit
- Created: 2018-10-02T18:45:27.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T02:08:32.000Z (14 days ago)
- Last Synced: 2024-10-29T16:01:37.338Z (13 days ago)
- Language: TypeScript
- Homepage:
- Size: 4.52 MB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/Borewit/tokenizer-http/actions/workflows/nodejs-ci.yml)
[](https://github.com/Borewit/tokenizer-http/actions/workflows/github-code-scanning/codeql)
[](https://www.npmjs.com/package/@tokenizer/http)
[](https://npmcharts.com/compare/@tokenizer/http?interval=30)
[](https://snyk.io/test/github/Borewit/tokenizer-http?targetFile=package.json)
# @tokenizer/http
Specialized [strtok3 tokenizer](https://github.com/Borewit/strtok3#tokenizer) for HTTP(S) [RFC-7233](https://tools.ietf.org/html/rfc7233#section-2.3) [range request](https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests) transfer.
The [range request](https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests) will ensure only the data is downloaded, which is actually being read, and data [ignored](https://github.com/Borewit/strtok3#method-tokenizerignore) will not be downloaded.
The range request mechanism is derived from [@tokenizer/range](https://github.com/Borewit/tokenizer-range).
## Installation
Install using [npm](https://www.npmjs.com/get-npm):
```shell script
npm install @tokenizer/http
```
or using [yarn](https://yarnpkg.com/):
```shell script
yarn add @tokenizer/http
```
## Usage
### Configuration options
* `resolveUrl`, `boolean`, default value is `true`. Enable caching of redirects of HEAD requests.
### Example
```js
// const mm = require('music-metadata-browser'); // Use module 'music-metadata-browser' client side
const mm = require('music-metadata'); // Use module 'music-metadata' in Node.js
const {makeTokenizer} = require('@tokenizer/http');
const audioTrackUrl = 'https://test-audio.netlify.com/Various%20Artists%20-%202009%20-%20netBloc%20Vol%2024_%20tiuqottigeloot%20%5BMP3-V2%5D/01%20-%20Diablo%20Swing%20Orchestra%20-%20Heroines.mp3';
(async () => {
const httpTokenizer = await makeTokenizer(audioTrackUrl);
const metadata = await mm.parseFromTokenizer(httpTokenizer);
console.log('metadata:', metadata);
})();
```
## Server requirements
The server needs to send the following headers:
| HTTP header-| Value |
|-------------|-------|
| [Access-Control-Allow-Origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) | "*" |
| [Access-Control-Allow-Methods](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) | "GET,HEAD,OPTIONS" |
| [Access-Control-Allow-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) | "Content-Type, Range" |
| [Access-Control-Expose-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) | "Content-Length, Content-Range" |
Example configuring Apache for streaming. Add the following to `.htaccess` in the folder sharing your audio tracks:
```
Header set Access-Control-Allow-Origin "*"
Header set Access-Control-Allow-Methods "GET,HEAD,OPTIONS"
Header set Access-Control-Allow-Headers "Content-Type, User-Agent, If-Modified-Since, Cache-Control, Range"
Header set Access-Control-Expose-Headers "Content-Length, Content-Range"
```
Ref:
* [streamroot.io: Range requests basics](https://support.streamroot.io/hc/en-us/articles/115003168773-Range-requests-basics)
Try if range request is supported:
```bash
curl -v -L --header "range: bytes=1-8" http://localhost:8080/bbb/test
```
## Dependencies
## Licence
(The MIT License)
Copyright (c) 2018 Borewit
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.
git pull
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.