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

fs-path

v0.0.25

Published

file and directory op libs, find, findSync, mkdir, mkdirSync, copy, copySync, remove, removeSync, writeFile, writeFileSync

Downloads

25,722

Readme

fs-path

Build Status


find(path [,filter] [,callback])

Recurcively scan files or scan files by a filter.

Callback break tow arguments: err, list

var fsPath = require('fs-path');

fsPath.find('/usr/local', function(err, list){
  console.log(list.dirs);
  console.log(list.files);
});

The value list is an object has two keys:

{
  dirs: [
    '/usr/local/test'
    '/usr/local/test/abc'
  ],
  files: [
    '/usr/local/aaa.png',
    '/usr/local/test/bbb.gif',
    '/usr/local/test/abc/ddd.html'
  ]
}

If you set a filter to map the files or directories, you can do like this:

var fsPath = require('fs-path');

fsPath.find('/usr/local', function(filepath, stats, filename){
  if(stats === 'file' && /\.png$/.test(filename)){
    return false;
  }
  return true;
}, function(err, list){
  console.log(list.dirs);
  console.log(list.files);
});

filter has 3 arguments:

  • filepath: the full path of the file or directory
  • stats: the type of file or directory, has two value: file, directory
  • filename: the name of the file or directory

It will return the list:

{
  dirs: [
    '/usr/local/test'
    '/usr/local/test/abc'
  ],
  files: [
    '/usr/local/test/bbb.gif',
    '/usr/local/test/abc/ddd.html'
  ]
}

findSync(path[ ,filter])

Sync version of find(). Throws exception on error.

mkdir(path[, callback])

Recursively make, if the parent path not exists, it'll create the directory automatically.

var fsPath = require('fs-path');

fsPath.mkdir('/usr/local/test1/test2/test3', function(err){
  console.log('ok');
});

mkdirSync(path[ ,pattern])

Sync version of mkdir(). Throws exception on error.

copy(from, dist[, callback])

Copy a file or directory to other path, if the parent path not exists, it'll create the directory automatically.

var fsPath = require('fs-path');

fsPath.copy('/usr/local/test1/test2/test3', '/usr/local/aaaa', function(err){
  console.log('ok');
});

copySync(path[ ,pattern])

Sync version of copy(). Throws exception on error.

remove(path[, callback])

Delete a file or directory.

var fsPath = require('fs-path');

fsPath.remove('/usr/local/test1/test2/test3', function(err){
  console.log('ok');
});

removeSync(path)

Sync version of remove(). Throws exception on error.

writeFile(path, content[, encoding][, callback])

Write a file a file or directory.

Encoding is optional, default is 'utf-8'.

var fsPath = require('fs-path');

fsPath.writeFile('/usr/local/1.html', content function(err){
  console.log('ok');
});

writeFileSync(path, content[, encoding])

Sync version of writeFile(). Throws exception on error.