npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ffos-fs

v0.0.7

Published

fs module for the Firefox OS

Downloads

5

Readme

ffos-fs

File System (fs) module for the Firefox OS

Provides file system functions for the Firefox OS and devices supporting device storage.

It tries to mimic node's fs module where possible.

By the very nature of the device storage it only implements a subset of node's fs module.

Usage

Higher level functions

var fs = require('ffos-fs');

Get files within a directory. Returned files are of type File.

fs.readdir(path, callback(error, files) { ... });

Read contents of a file.

options

  • format String | Null default = 'text', can be 'text', 'binary', 'dataURL', 'buffer'
  • encoding String | Null default = null, text encoding if format is 'text'
  • flag String default = 'r', can be 'r' or 'w'
fs.readFile(path, [options], callback(error, data) { ... });

Write contents to a file.
Will create the file if it does not exist and overwrite an existing file.

options

  • encoding String | Null default = 'utf8'
  • mimetype String | Null default = 'text/plain'
  • flag String default = 'w'
fs.writeFile(path, data, [options], callback(error) { ... });

Check if a file exists.
You cannot check for the existance of a directory on Firefox OS.

fs.exists(path, callback(error, exists) { ... });

Remove a file or directory.

fs.unlink(path, callback(error) { ... });

Lower level functions

Open a File handle.

flag can be one of 'r' or 'w'.

fd is either of type File (read) or of type FileHandle (write).

fs.open(path, flag, callback(error, fd) { ... });

Read from a file to a Blob.

fd must be of type FileHandle or File or LockedFile.

blob is the blog that the data will be written to.

offset is the offset in the blob to start writing at.

length is an integer specifying the number of bytes to read.

position is an integer specifying where to begin reading from in the file. If position is null, data will be read from the start.

fs.read(fd, blob, offset, length, position, callback(error, bytesRead, blob) { ... });

Write from a blob to a file Blob.

fd must be of type FileHandle or File or LockedFile.

blob is the blog that the data will be written to.

offset is the offset in the blob to start writing at.

length is an integer specifying the number of bytes to read.

position is an integer specifying where to begin reading from in the file. If position is null, data will be read from the start.

fs.read(fd, blob, offset, length, position, callback(error, bytesRead, blob) { ... });

Mocking the filesystem

It's possible to mock the filesystem to an in-memory filesystem.

fs.mock();

Currently there is no support for the Lower level functions in mock mode.

You can however use:

  • fs.writeFile
  • fs.exists
  • fs.readFile
  • fs.readdir
  • fs.unlink

If you need to prepopulate your mocked filesystem with files just use fs.writeFile to create some files.