Skip to content

brianwk/asyncfs-s3

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@softwaredeployed/asyncfs-s3

A (partially implemented) drop in replacement for asyncFs and path node modules.

Why?

I was launching a website quickly for a client on Amazon Web Services infrastructure. The software used the asyncFs and path node modules without any abstraction to save the user uploaded assets. I created this module as a drop-in replacement for asyncFs and path that understands "s3://" prefix. The outcome is behavior similar to "stream wrappers" in the PHP programming language.

Install via NPM (or your favorite package manager)

npm install @softwaredeployed/asyncfs-s3

Intended usage

Say you have imports like:

import asyncFs from "node:fs/promises";
import path from "node:path";

You can replace these imports with:

import { asyncFs, path } from "@softwaredeployed/asyncfs-s3";

Future plan

Implement the other asyncFs and path functions to provide a complete drop in replacement. If you want to help, PRs are welcome.

Questions

Please raise a GitHub issue or contact me via the link to my website below.


An open source project by Software Deployed

About

asyncFS and path with NodeJS-like API compatible with s3:// prefixed paths

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published