SimpleFS

A minimal, extensible and promise based filesystem layer for modern browsers.

Live Demo

Supported backeneds

• IndexedDB (default)
• Memory (experimental and used for testing)

Installation

npm:

npm install --save @forlagshuset/simple-fs

Usage

browser (umd):

<script src='https://unpkg.com/@forlagshuset/[email protected]/dist/SimpleFS.min.js' async></script>
<script>
  const fs = new SimpleFS({name:'storage-name'})
  // do stuff

  await fs.mkdir('/myproject')

  // create a file under root folder
  const content = new Blob(['This is my cool project'], {type: 'plain/text'})
  await fs.writeFile('/myproject/test.txt', content)

  // get content as blob
  let blob = await fs.readFile('/myproject/test.txt')

</script>

browser (modules)

import SimpleFS from '@forlagshuset/simple-fs'
// OR es6 modules from unpkg
import SimpleFS from "//unpkg.com/@forlagshuset/simple-fs?module"

const fs = new SimpleFS({name: 'storage-name'})

// first create root folder
await fs.mkdir('/myproject')

// create a file under root folder
const content = new Blob(['This is my cool project'], {type: 'plain/text'})
await fs.writeFile('/myproject/test.txt', content)

// get content as blob
let blob = await fs.readFile('/myproject/test.txt')

API

mkdir(<path>)
mkdirParents(<path>) // wraps mkdir -p
rmdir(<path>)
rmdirRecursive(<path>) // removes dirs recursively
readFile(<path>, <options>={}) // returns Blob
writeFile(<path>, <data>, <options>={}) // data should be Blob type
outputFile(<path>, <data>, <options>={}) // Wraps writeFile and recursively creates path if not exists
unlink(<path>)
exists(<path>)
stats(<path>)

Browser support

• Chrome
• IE Edge
• Firefox
• Safari