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

promise-filesystem

v1.0.1

Published

[![Build Status](https://travis-ci.org/AlessioCoser/promise-filesystem.svg?branch=master)](https://travis-ci.org/AlessioCoser/promise-filesystem)

Downloads

42

Readme

Build Status

promise-filesystem

Provides promise based filesystem API for node.js. This is also an adapter for remote filesystems like Amazon Simple Storage Service (AWS S3).

Filesystems supported

  • Local filesystem
  • AWS S3

Use AWS S3

In order to work with AWS S3 you have to pass aws-s3 sdk to promise-filesystem:

npm install --save aws-sdk

and set 2 environment variables:

export AWS_ACCESS_KEY_ID = [your_aws_access_key]
export AWS_SECRET_ACCESS_KEY = [your_aws_secret_key]

Initialize Filesystem:

// initialize local file system
const localFileSystem = require('promise-filesystem')()

// initialize s3 file system
const aws = require('aws-sdk')
const s3FileSystem = require('promise-filesystem')(aws.S3)

Features

  • head
  • read
  • read (with range)
  • write
  • delete
  • readAsStream
  • writeAsStream

head

const localFileSystem = require('promise-filesystem')()

return localFileSystem.head(folder, fileName)
.then(function (data) {
  console.log(data)
  /* { AcceptRanges: 'bytes',
       LastModified: 2017-05-08T12:32:16.000Z,
       ContentLength: 28,
       ETag: null,
       ContentType: null,
       Metadata: {} } */
})

read

const localFileSystem = require('promise-filesystem')()

return localFileSystem.read(folder, fileName)
.then(function (data) {
  console.log(data)
  // { Body: 'Lorem ipsum dolor sit amet.\n' }
})

read (with range)

const localFileSystem = require('promise-filesystem')()

return localFileSystem.read(folder, fileName, 'bytes=0-3')
.then(function (data) {
  console.log(data)
  // { Body: 'Lore' }
})

write

const localFileSystem = require('promise-filesystem')()
let content = 'Lorem ipsum dolor sit amet.\n'

return localFileSystem.write(folder, fileName, content)
.then(function () {
  // do whatever you want
})
.catch(function (err) {
  console.log(err)
  /* { Error: EACCES: permission denied, open 'folder/file.ext'
       errno: -13,
       code: 'EACCES',
       syscall: 'open',
       path: 'folder/file.ext' } */
})

delete

const localFileSystem = require('promise-filesystem')()

return localFileSystem.delete(folder, fileName)
.then(function () {
  // do whatever you want
})
.catch(function (err) {
  console.log(err)
  /* { Error: EACCES: permission denied, open 'folder/file.ext'
       errno: -13,
       code: 'EACCES',
       syscall: 'open',
       path: 'folder/file.ext' } */
})

readAsStream

const localFileSystem = require('promise-filesystem')()
let stream = localFileSystem.readAsStream(folder, fileName)

stream.on('data', function(chunk) {
  console.log(chunk)
})

writeAsStream

const localFileSystem = require('promise-filesystem')()
let myStream = getMySuperStream()

localFileSystem.writeAsStream(folder, fileName, myStream)
.then(function (data) {
  console.log('write successfully with this informations', data)
  // => { Location: 'folder/file.ext', Folder: 'folder', FileName: 'file.ext' }
})
.catch(function (err) {
  console.log('There was a readStream error: ', err)
})