Skip to content

Latest commit

 

History

History
113 lines (83 loc) · 2.68 KB

README.md

File metadata and controls

113 lines (83 loc) · 2.68 KB
Raw

fake-fs

Fake node.js file system for testing. Supports stat, readdir, readFile, exists and their sync counterparts. Perhaps more methods will be added in future.

Usage

var fs = require('fake-fs')

Define a dir

// note that it works like mkdir -p
fs.dir('a/b/c')

fs.existsSync('a').should.be.true
fs.existsSync('a/b/c').should.be.true

Dir with some meta

fs.dir('bin', {
  mtime: 100,
  atime: 300,
  ctime: 50
})
fs.statSync('bin').should.have.property('mtime').equal(100)

Define an empty file

fs.file('foo/bar.txt')

fs.readFileSync('foo/bar.txt', 'utf8').should.equal('')
fs.statSync('foo').isDirectory().should.be.true // foo automatically created

Define a file with content

fs.file('hello.txt', 'Hello world') // utf8 assumed
fs.file('base64.txt', 'TWFu', 'base64')
fs.file('bin', new Buffer([10, 20]))

Define a file with arbitrary attributes

fs.file('file', {
  content: 'asdf',
  mtime: new Date,
  hello: 'hello'
})

fs.readFileSync('file', 'utf8').should.equal('asdf')
fs.statSync('file').should.have.property('hello').equal('hello')

Sometimes you may want to define several items at one location. The .at(path) returns a proxy which prefixes everything you defined with path.

fs.at('public/assets')
  .file('style.css')
  .file('icons.png')

fs.existsSync('public/assets/icons.png').should.be.true

Installation

Via npm

npm install fake-fs

To run tests install dev dependencies and execute npm test command.

npm install -d
npm test

License

(The MIT License)

Copyright (c) 2012 Eldar Gabdullin eldargab@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.