geut / hyperdrive-promise Goto Github PK

View Code? Open in Web Editor NEW

15.0 15.0 6.0 184 KB

Promise wrapper for Hyperdrive

JavaScript 100.00%

async-await dat hyperdrive p2p

hyperdrive-promise's Introduction

hyperdrive-promise

An async/await based wrapper for hyperdrive (v10+)

Install

$ npm install @geut/hyperdrive-promise

Usage

hyperdrive-promise its totally API compatible with hyperdrive v10+. It's only a promise based wrapper.

E.g.:

const hyperdrive = require('@geut/hyperdrive-promise')
const archive = hyperdrive('./my-first-hyperdrive') // content will be stored in this folder

try {
  await archive.writeFile('/hello.txt', 'world')
  const list = await archive.readdir('/')
  console.log(list) // prints ['hello.txt']
  const data = await archive.readFile('/hello.txt', 'utf-8')
  console.log(data) // prints 'world'
} catch (err) {
  console.log(err)
  // deal with the err
}

Release

npm version && npm publish

Contributing

👥 Ideas and contributions to the project are welcome. You must follow this guideline.

hyperdrive-promise's People

Contributors

Stargazers

Watchers

Forkers

mdheller socioprophet rangermauve saranrapjs dwebprotocol bitwebs

hyperdrive-promise's Issues

Update hyperdrive

Update code and tests to be compatible with latest hyperdrive (>10.4.x)

An in-range update of standard is breaking the build 🚨

🚨 Reminder! Less than one month left to migrate your repositories over to Snyk before Greenkeeper says goodbye on June 3rd! 💜 🚚💨 💚

Find out how to migrate to Snyk at greenkeeper.io

The devDependency standard was updated from `14.3.3` to `14.3.4`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

standard is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ Travis CI - Branch: The build failed.

Release Notes for 14.3.4 - 2020-05-11

Relax no-return-await rule (#1442)

Commits

The new version differs by 12 commits.

bf35e5f 14.3.4
5b2af9c Merge pull request #1515 from Vrq/master
bca7bd2 Add SwissDev JS Jobs to users
5040cff Merge pull request #1512 from iaurg/patch-1
64c0486 Adjusting some typo errors in PT-BR Readme
c713105 Merge pull request #1510 from HCLonely/master
fc0ab4f Fix link cannot be positioned correctly
c93f3f3 Fix link cannot be positioned correctly
8445fee Merge pull request #1506 from joshuagoran/patch-1
0243b25 clarify constructor-super rule example
a9dad9e Merge pull request #1502 from standard/greenkeeper/eslint-config-standard-14.1.1
282702b fix(package): update eslint-config-standard to version 14.1.1

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

add greenkeeper support

Typescript typings

Hey, would y'all be down for a PR that adds TypeScript declarations to this repo?

I was thinking of using it for a TypeScript project and thought it'd be useful to have the types directly in here for future use.

An in-range update of hyperdrive is breaking the build 🚨