@dpongimo/async-hydrus.js v2.0.0-alpha6

hydrus.js

ESM Module for interacting with the Hydrus Client HTTP API.

Originally created and maintained by cravxx, this variant attempts to provide Typescript annotations for all covered endpoints and is designed to allow for use in Node.js and in the Browser.

Example

ESM import in the browser

import { Hydrus } from "@dpongimo/async-hydrus.js";

const client = new Hydrus({
	access_key: "eb79e9e2a40dddd159299408db072ed6e6573d488b50db499f70a211ba1fa1da",
	fetch: window.fetch,
});

console.info(await client.getVersion());

CommonJS import in NodeJs:

const { Hydrus } = require("@dpongimo/async-hydrus.js");
const fetch = require("node-fetch");

const client = new Hydrus({
	access_key: "eb79e9e2a40dddd159299408db072ed6e6573d488b50db499f70a211ba1fa1da",
	fetch,
});

console.info(await client.getVersion());

Usage

const client = new Hydrus({
	address: URL, // URL to your Hydrus Client's HTTP API endpoint (default "http://127.0.0.1:45869")
	access_key: string, // Hydrus Access Key (can be provided later)
	fetch,
});

Authentication

Files

Pages