@filebase/client
v0.0.5
Published
A client library for the https://filebase.com/ service. It provides a convenient interface for working with the S3 API and IPFS Buckets from Node.js
Downloads
3,031
Readme
@filebase/client
A client library for the https://filebase.com/ service. It provides a convenient interface for working with the Raw HTTP API from a web browser or Node.js and comes bundled with TS for out-of-the box type inference and better IntelliSense.
Install
Install the package using npm
npm install @filebase/client
Or yarn
yarn add @filebase/client
Usage
First, obtain an API token from https://filebase.com and use it in place of API_TOKEN
below:
import { FilebaseClient, File } from '@filebase/client'
const filebaseClient = new FilebaseClient({ token: 'API_TOKEN' })
const metadata = await filebaseClient.store({
name: 'Pinpie',
description: 'Pin is not delicious beef!',
image: new File(
[
/* data */
],
'pinpie.jpg',
{ type: 'image/jpg' }
),
})
console.log(metadata.url)
// ipfs://bafyreib4pff766vhpbxbhjbqqnsh5emeznvujayjj4z2iu533cprgbz23m/metadata.json
import { FilebaseClient } from '@filebase/client'
const filebaseClient = new FilebaseClient({ token: 'API_TOKEN' })
const content = new Blob(['hello world'])
const cid = await filebaseClient.storeBlob(content)
console.log(cid);
// Qmf412jQZiuVUtdgnB36FXFX7xg5V6KEbSJ4dpQuhkLyfD
The client uses ESM modules. If running from Node.js, either name your script index.mjs
or name it index.js
and use npm init
to create a new package.json
file in your project directory, adding "type": "module",
to it.
Run the script:
node index.mjs # or index.js
For more examples please see the API documentation.