idb-fs

node.js fs/promises api implemented using indexedDB

TO-DOs

• [x] fsPromises.copyFile(src, dest[, mode])
• [x] fsPromises.lstat(path[, options])
• [x] fsPromises.mkdir(path[, options])
• [x] fsPromises.readdir(path[, options])
• [x] fsPromises.readFile(path[, options])
• [x] fsPromises.rename(oldPath, newPath)
• [x] fsPromises.rmdir(path[, options])
• [x] fsPromises.rm(path[, options])
• [x] fsPromises.stat(path[, options])
• [x] fsPromises.unlink(path)
• [x] fsPromises.watch(filename[, options])
• [x] fsPromises.writeFile(file, data[, options])
• [x] ~~fsPromises.exists(path)~~ deprecated

Low priority

• [ ] fsPromises.lutimes(path, atime, mtime)
• [ ] fsPromises.mkdtemp(prefix[, options])
• [ ] fsPromises.utimes(path, atime, mtime)

Currently no plan

• [ ] fsPromises.access(path[, mode])
• [ ] fsPromises.appendFile(path, data[, options])
• [ ] fsPromises.chmod(path, mode)
• [ ] fsPromises.chown(path, uid, gid)
• [ ] fsPromises.cp(src, dest[, options])
• [ ] fsPromises.lchmod(path, mode)
• [ ] fsPromises.lchown(path, uid, gid)
• [ ] fsPromises.link(existingPath, newPath)
• [ ] fsPromises.open(path, flags[, mode])
• [ ] fsPromises.opendir(path[, options])
• [ ] fsPromises.readlink(path[, options])
• [ ] fsPromises.realpath(path[, options])
• [ ] fsPromises.symlink(target, path[, type])
• [ ] fsPromises.truncate(path[, len])

Usage

import { createFs } from 'idb-fs'

const fs = createFs()

const main = async () => {
  await fs.writeFile('./a.md', 'test')

  const file = await fs.readFile('./a.md', {
    encoding: 'utf-8',
  })

  console.log(file)
  // -> 'test'
}

main()