firescript-firefs

File System lib for Firescript

Usage no npm install needed!

<script type="module">
  import firescriptFirefs from 'https://cdn.skypack.dev/firescript-firefs';
</script>

README

FireFS

File System lib for Firescript

Usage

Check file or dir exists

import FireFS from 'firescript-firefs'

const fs = await FireFS.path('/foo/bar/blub')

if (fs.exists) {
  console.log('File exists')
}
Check file or dir exists shorthand
import FireFS from 'firescript-firefs'

const content = await FireFS.pathExists('/foo/bar/blub')

Read file

import FireFS from 'firescript-firefs'

const fs = await FireFS.file('/foo/bar/blub')
const content = await fs.read()
Read file shorthand
import FireFS from 'firescript-firefs'

const content = await FireFS.readFile('/foo/bar/blub')

Write file

import FireFS from 'firescript-firefs'

const fs = await FireFS.file('/foo/bar/blub')
await fs.write('Content')
Write file shorthand
import FireFS from 'firescript-firefs'

const fs = await FireFS.writeFile('/foo/bar/blub', 'Content')

Read JSON file

import FireFS from 'firescript-firefs'

const fs = await FireFS.file('/foo/bar/blub.json')
const json = await fs.readJSON()
Read JSON file shorthand
import FireFS from 'firescript-firefs'

const json = await FireFS.readJSON('/foo/bar/blub.json')

Write JSON file

import FireFS from 'firescript-firefs'

const fs = await FireFS.file('/foo/bar/blub')
await fs.writeJSON('Content')
Write JSON file shorthand
import FireFS from 'firescript-firefs'

const fs = await FireFS.writeJSON('/foo/bar/blub', 'Content')

Check whether a file or dir exists

returns bool true if path exists, otherwise false

import FireFS from 'firescript-firefs'

const exists = await FireFS.pathExists('/foo/bar/blub')

Read dir

import FireFS from 'firescript-firefs'

const fs = await FireFS.dir('/foo/bar/blub')
const content = await fs.list()
Read dir shorthand
import FireFS from 'firescript-firefs'

const content = await FireFS.readDir('/foo/bar/blub')

Watch file

import FireFS from 'firescript-firefs'

const fs = await FireFS.file('/foo/bar/blub/foo.txt')
const content = await fs.watch((fl) => {
  console.log(`File ${fl.name} changed`)
})

Watch dir

import FireFS from 'firescript-firefs'

const fs = await FireFS.dir('/foo/bar/blub/')
const content = await fs.watch((fl) => {
  console.log(`File ${fl.name} changed`)
})