npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@joaopaulo.vieira/transcriptore

v1.0.0

Published

Parse a stream to text.

Downloads

2

Readme

Coveralls github Travis (.com)

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 on localhost:8080);
  • Run npm test to check project tests;
  • Run npm run lint to validate project lint rules;