fs-sync/README.md

# 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');
	}
	
	// You can also use methods of the built-in `fs`
	
	fs.readFileSync(...);
	
	
## Methods

	var fs = require('fs-sync');
	
### fs.defaultEncoding
Type: `String`

Default value: `'utf-8'`

Global default encoding

	fs.defaultEncoding = 'utf-8'

### fs.copy()

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()
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](http://nodejs.org/api/fs.html#fs_fs_writefile_filename_data_options_callback)

### fs.read(file, options)
Read a file

#### options
Type: `Object`

The same as the `options` argument of [fs.writeFile](http://nodejs.org/api/fs.html#fs_fs_readfile_filename_options_callback), 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.delete()

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

#### Syntax
	
	fs.delete(file)
	fs.delete(dir)


### fs.exists()

`arguments` will be called with `path.join`

### fs.isDir()

### fs.isFile()

### fs.isLink()