@joaopaulo.vieira/transcriptore
v1.0.0
Published
Parse a stream to text.
Downloads
1
Maintainers
Readme
How it works
This is our file example(lorem_ipsum.txt
):
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Now, we just need to read this file via one ReadableStream and pass the promise returned from the read method of the ReadableStream and call the readBuffer
method of our Transcriptore
instance to get the parsed text.
For the sake of practicality, we can use the Fetch API:
import Transcriptore from 'transcriptore.js'
const parser = new Transcriptore()
fetch('https://example.com/path/lorem_ipsum.txt').then(reponse => {
// response.body is a ReadableStream! See: https://developer.mozilla.org/en-US/docs/Web/API/Body/body
const reader = response.body.getReader()
reader.read().then(buffer => console.log(parser.readBuffer(buffer)))
})
// output: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Transcriptore.js
also have the fetchAndParse
method to just pass one URL and receives the parsed file text:
import Transcriptore from 'transcriptore.js'
const parser = new Transcriptore()
// The method uses Fetch API so, it's possible to pass the fetch config options to too.
parser.fetchAndParse('https://example.com/path/lorem_ipsum.txt', { mode: 'cors' }).then(text => console.log(text))
// output: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Transcriptore.js
also work via Node.js:
// parse_lorem_ipsum.js
import Transcriptore from 'transcriptore'
import fetch from 'node-fetch'
global.fetch = fetch
const transcriptore = new Transcriptore()
parser.fetchAndParse('https://example.com/path/lorem_ipsum.txt', { mode: 'cors' }).then(text => console.log(text))
Then:
node parse_lorem_ipsum.txt
// output: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Demos
Check public/index.html
for browser demo and public/node_example.js
for Node.js demo.
Development
- Run
npm i
to setup local environment; - Run
npm run build
to generate dist files; - Run
npm start
to run demo page (up onlocalhost:8080
); - Run
npm test
to check project tests; - Run
npm run lint
to validate project lint rules;