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

find

Package Overview
Dependencies
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

find

Find files or directories by name

  • 0.3.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
993K
decreased by-10.36%
Maintainers
1
Weekly downloads
 
Created
Source

find Status

Find files or directories by name.

NPM

Installation

$ npm install --save find

Examples

Find all files in current directory.

var find = require('find');

find.file(__dirname, function(files) {
  console.log(files.length);
})

Filter by regular expression.

find.file(/\.js$/, __dirname, function(files) {
  console.log(files.length);
})

Features

  • Recursively search each sub-directories
  • Asynchronously or synchronously
  • Filtering by regular expression or string comparing

Changelog

0.3.0
  • Added .use() method
0.2.0
  • The first pattern option is now optional
  • Will follow symbolic links

API

.file([pattern,] root, callback)
find.file(__dirname, function(files) {
  //
})
.dir([pattern,] root, callback)
find.dir(__dirname, function(dirs) {
  //
})
.eachfile([pattern,] root, action)
find.eachfile(__dirname, function(file) {
  //
})
.eachdir([pattern,] root, action)
find.eachdir(__dirname, function(dir) {
  //
})
.fileSync([pattern,] root)
var files = find.fileSync(__dirname);
.dirSync([pattern,] root)
var dirs = find.dirSync(__dirname);
.error([callback])

Handling errors in asynchronous interfaces

find
  .file(__dirname, function(file) {
    //
  })
  .error(function(err) {
    if (err) {
      //
    }
  })
.end([callback])

Detect end in find.eachfile and find.eachdir

find
  .eachfile(__dirname, function(file) {
    //
  })
  .end(function() {
    console.log('find end');
  })
.use(Options)
  • fs: The internal fs object to be used.
const { fs, vol } = require('memfs');

const json = {
  './README.md': '1',
  './src/index.js': '2'
};

vol.fromJSON(json, '/app');

find
  .use({ fs: fs })
  .file('/app', console.log);

Keywords

FAQs

Package last updated on 07 Mar 2019

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