datastore-s3

Datastore implementation with S3 backend

Showing:

Popularity

Downloads/wk

219

GitHub Stars

49

Maintenance

Last Commit

1mo ago

Contributors

6

Package

Dependencies

6

License

(Apache-2.0 OR MIT)

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

js-datastore-s3

Build Status codecov Dependency Status js-standard-style

Datastore implementation backed by s3.

Lead Maintainer

Jacob Heun

Table of Contents

Install

$ npm install datastore-s3

Usage

If the flag createIfMissing is not set or is false, then the bucket must be created prior to using datastore-s3. Please see the AWS docs for information on how to configure the S3 instance. A bucket name is required to be set at the s3 instance level, see the below example.

import S3 from 'aws-sdk/clients/s3.js'
import { S3Datastore } from 'datastore-s3'

const s3Instance = new S3({ params: { Bucket: 'my-ipfs-bucket' } })
const store = new S3Datastore('.ipfs/datastore', {
  s3: s3Instance
  createIfMissing: false
})

Create a Repo

See examples/full-s3-repo for how to quickly create an S3 backed repo using the createRepo convenience function.

Examples

You can see examples of S3 backed ipfs in the examples folder

Contribute

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

License

Apache-2.0 OR MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial