Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

file-reader

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

file-reader

Read a glob of files, dynamically choosing the reader or requiring the files based on the file extension.

  • 1.1.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
3.4K
increased by39.01%
Maintainers
1
Weekly downloads
 
Created
Source

file-reader NPM version NPM downloads Build Status

Read a glob of files, dynamically choosing the reader or requiring the files based on the file extension.

Install

Install with npm:

$ npm install file-reader --save

Usage

Read a glob of files:

var read = require('file-reader');

read('*.js');
//=> { a: [Function: aaa], b: [Function: bbb], c: [Function: ccc] }

read('*.txt');
//=> { a: 'AAA', b: 'BBB', c: 'CCC' }

read('*.{yml,json}');
//=> { a: { a: 'a' }, b: { b: 'b' }, c: { c: 'c' } }

Read a single file (you must supply the full file path, no glob patterns):

var read = require('file-reader');

read.file('a.js');
//=> { a: [Function: foo] }

read.file('a.txt');
//=> { a: 'foo' }

read('a.yml');
//=> { a: { foo: 'bar' } }

You might also be interested in these projects:

  • map-files: Return an object for a glob of files. Pass a rename function for the keys,… more | homepage
  • parse-filepath: Pollyfill for node.js path.parse, parses a filepath into an object. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.


This file was generated by verb, v0.9.0, on April 23, 2016.

Keywords

FAQs

Package last updated on 23 Apr 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc