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
npm install @filebase/client[![package][version.icon]][package.url]
[![styled with prettier][prettier.icon]][prettier.url]
[![size][size.icon]][size.url]
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 the package using npm
``
npm install @filebase/client
Or yarn
`
yarn add @filebase/client
First, obtain an API token from https://filebase.com and use it in place of API_TOKEN below:
`js
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
`
`js
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:
`sh``
node index.mjs # or index.js
For more examples please see the API documentation.
[raw http api]: https://docs.filebase.com/api-documentation/s3-compatible-api
[node.js]: https://nodejs.org/
[api documentation]: [https://docs.filebase.com/code-development-+-sdks/code-development/filebase-npm-package]
[version.icon]: https://img.shields.io/npm/v/filebase-js.svg
[package.url]: https://npmjs.org/package/@filebase/client
[prettier.icon]: https://img.shields.io/badge/styled_with-prettier-ff69b4.svg
[prettier.url]: https://github.com/prettier/prettier
[size.icon]: https://badgen.net/bundlephobia/minzip/@filebase/client
[size.url]: https://bundlephobia.com/result?p=@filebase/client