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-sync

v1.0.6

Published

synchronous fs with more fun

Downloads

66,495

Readme

Build Status

fs-sync

Synchronous fs with more fun

Getting Started

This module is created for the favor of use of fs.xxxSync.

Once fs-sync is installed, you can use:

var fs = require('fs-sync');

if(fs.exists('package.json')){
	var pkg = fs.readJSON('package.json');
}

Methods

var fs = require('fs-sync');

fs.defaultEncoding

Type: String

Default value: 'utf-8'

Global default encoding

fs.defaultEncoding = 'utf-8'

fs.copy(from, to, options)

Copy a file or a whole directory to the destination. During this, necessary directories will be created.

Syntax

fs.copy(file, destpath, options);
fs.copy(dir, destpath, options);

file

Type: String

Path of file to be copied

dir

Type: String

Path of directory to be copied

options.force

Type: Boolean

Default value: false

By default, fs.copy will not override existed files, set options.force as true to override.

fs.mkdir(path)

Commandline mkdir or mkdir -p

fs.expand(patterns, options)

Like grunt.file.expand, but the sequence of the arguments is different

fs.write(file, content, options)

options

Type: Object

The same as the options argument of fs.writeFile

fs.read(file, options)

Read a file

options

Type: Object

The same as the options argument of fs.writeFile, except:

options.encoding

Type: String

Default value: fs.defaultEncoding

fs.readJSON(file, options)

Read a file as the JSON format, if the file content fails to be parsed as JSON, an error will be thrown.

fs.remove()

Delete a file or a whole directory. It's a dangerous action, be careful.

Equivalent to rm -rf(remove a folder and all its contents) or rm -f(unlink a file)

Syntax

fs.remove(file)
fs.remove(dir)

fs.exists(...)

arguments will be called with path.join

fs.isDir(path)

fs.isFile(path)

fs.isLink(path)

fs.isPathAbsolute(path)

Returns Boolean

Whether the given path is an absolute path (starting with '/')

fs.doesPathContain(ancestor, path...)

if(fs.doesPathContain(ancestor, path, path2)){
	console.log(path, 'and', path2, 'are inside', ancestor);
}

Returns Boolean

Whether path ancestor contains all paths after

ancestor String

Ancestor path

path String

The arguments of fs.doesPathContain could be more than 2.