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

source-extract

v1.1.1

Published

Extract exports from plain js object, js file streams, buffers or even strings

Downloads

2

Readme

JS module interpreter

Build Status Coverage Status npm version

Get the exports object from a stream, buffer, string or object representing a js module. see usage.

Installation

With npm:

npm install --save source-extract

extract is meant to be used on a commonjs environment (or es6 through transpilation) such as the one node provides, is has no browser support

Usage

let extract = require('source-extract');

// from a string source
let source =  ```
module.exports = {
  name: 'Mike Wazowski'
};
```;

console.log(extract.from(source).name) // Mike Wazowski

// extracting specific keys from a string source
console.log(extract.from(source, 'name')); // Mike Wazowski

// Extracting from a readable Stream
let fs = require('fs');

extract
  .from(fs.createReadStream('path/to/file')) // extracting from streams returns a Promise
  .then((result) => {
    // assuming the content of the file is the same as source.
    console.log(result.name) // Mike Wazowski
  });

/**
 * Notes:
 *
 * - Extracting from Buffer and Objects works the same way as extracting from strings.
 * - Extracting from streams works with any kind of readable streams, such as http responses, read file streams, etc..
 */

Documentation

| extract | | :--- | | .from(String|Buffer|Object source, String key='') -> any | | Extracting from a string, buffer or object will retrieve the exported object of that module. If key is provided, then the key property of the exported object will be returned, the whole exported object will be returned otherwise.| | .from(stream.Readable source, String key='' ) -> Promise.{any} | | Extracting from a readable stream works the same as extracting from a string but instead of returning the exported object itself, it returns a promise which will pass on the exports when resolve.|

Why?

The main goal of the package is to interpret js packages bundled on the run when on development. An example of such case would be server side rendering, when de server bundle is being watched and re-bundled when a file changes, we need to reinterpret the js bundle (which can come in any kind of format) on the run.


Made with :heart: by Alejo Rodriguez