https://github.com/queckezz/fs-from-object

Create files and folders in the filesystem directly from an object
https://github.com/queckezz/fs-from-object

Last synced: about 1 month ago
JSON representation

Create files and folders in the filesystem directly from an object

• Host: GitHub
• URL: https://github.com/queckezz/fs-from-object
• Owner: queckezz
• Created: 2016-11-17T14:38:11.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-16T11:02:49.000Z (almost 8 years ago)
• Last Synced: 2024-11-14T04:55:56.240Z (about 2 months ago)
• Language: JavaScript
• Size: 6.84 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        

# fs-from-object

[![npm version][version-image]][version-url]

[![build status][travis-image]][travis-url]

[![dependency status][david-image]][david-url]

[![license][license-image]][license-url]

[![js standard style][standard-image]][standard-url]

[![downloads per month][downloads-image]][downloads-url]

> ​:zap:​ Create files and folders in the filesystem directly from an object.

```js

const { fsFromObject } = require('fs-from-object')

const tree = [

  { name: 'index.txt', mtime: new Date('07/07/2016'), contents: 'Hello World!' },

  {

    name: 'folder',

    contents: [

      { name: 'one.txt', contents: 'Hello World!' },

      { name: 'empty.txt' }

    ]

  }

]

fsFromObject(process.cwd(), tree)

```

## Installation

```bash

> npm install fs-from-object

```

## API

### `fsFromObject(path: String, tree: Object)`

Creates the given `tree` representation at `path`.

#### Tree Nodes

Each node can have the following properties:

* **name:**  Name of the file or folder

* **contents:** File or folder contents (optional)

* **mtime:** Modified time of a file or directory (optional)

### `ephemeralFsFromObject(tree: Object, task: Function)`

Creates an ephemeral path with the given `tree` in it. As soon as `task` resolves, the folder will get deleted.

The ephemeral path has the following signature:

```js

`${os.tmpdir()}/${uuid.v4()}`

```

#### Example

```js

ephemeralFsFromObject([{ name: 'index.txt', contents: 'test' }], (ephemeralPath) => {

    return fs.readFile(join(ephemeralPath, 'index.txt'))

    // -> test

}).then(() => {

  // folder deleted here

})

```

## License

[MIT][license-url]

[travis-image]: https://img.shields.io/travis/queckezz/fs-from-object.svg?style=flat-square

[travis-url]: https://travis-ci.org/queckezz/fs-from-object

[version-image]: https://img.shields.io/npm/v/fs-from-object.svg?style=flat-square

[version-url]: https://npmjs.org/package/fs-from-object

[downloads-image]: https://img.shields.io/npm/dm/fs-from-object.svg?style=flat-square

[downloads-url]: https://npmjs.org/package/fs-from-object

[david-image]: http://img.shields.io/david/queckezz/fs-from-object.svg?style=flat-square

[david-url]: https://david-dm.org/queckezz/fs-from-object

[standard-image]: https://img.shields.io/badge/code-standard-brightgreen.svg?style=flat-square

[standard-url]: https://github.com/feross/standard

[license-image]: http://img.shields.io/npm/l/fs-from-object.svg?style=flat-square

[license-url]: ./license