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

sfss.api.endpoint

v0.0.2

Published

Simple FS Storage Service enable a node app to store/retieve JSON objects to/from the filesystem via HTTP

Downloads

14

Readme

Simple FS Storage API Endpoint

NPM version NPM downloads NPM license flattr

coverage David David

Builds uppon sfss.lib the Simple FS Storage library.

##Usage

Options

  • dataRoot (mandatory): {String} absolut path to the root directory of the store.
  • disableFileDeletion: {Boolean} makes sure that no file can be deleted.
  • disableDirectoryDeletion: {Boolean} makes sure that no directory can be deleted.

API

PUT api_root/sfss/tree[/path]

Creates a new directory (success Status Code 201):

{
    "data": {
        "ref": "/sfss/tree/trial",
        "action": "created"
    },
    "status": "success"
}

GET api_root/sfss/tree[/path]

Returns the directory content - files and subdirectories names as Array (success Status Code 200):

{
    "ref": "/sfss/tree/test",
    "type": "directoryContent",
    "data": [
        "first.json",
        "second.json",
        "sub"
    ],
    "status": "success"
}

DELETE api_root/sfss/tree[/path]

Deep deletion of the directory, like rm -rf (success Status Code 204): no body


PUT api_root/sfss/data[/path]/filename.json

Creates or updates a file (success Status Code 201):

{
    "ref": "/sfss/data/test/first.json",
    "data": {
        "fileId": 1
    },
    "status": "success"
}

GET api_root/sfss/data[/path]

Reads all files in the directory (bulk read) (success Status Code 200):

{
    "ref": "/sfss/data/test",
    "type": "multipleFileContent",
    "data": [
        {
            "fileId": 1
        },
        {
            "fileId": 2
        }
    ],
    "status": "success"
}

GET api_root/sfss/data[/path]/filename.json

Reads a file (success Status Code 200):

{
    "ref": "/sfss/data/test/first.json",
    "type": "fileContent",
    "data": {
        "fileId": 1
    },
    "status": "success"
}

DELETE api_root/sfss/data[/path]/filename.json

Removes a file (success Status Code 204): no body