Blockpipe Client

Blockpipe Client is a TypeScript library for non-React web applications that provides an easy and seamless way to fetch data from Blockpipe Endpoint API. It supports fetching data from multiple endpoints with a single call and is configurable with your project and API settings.

Installation

Install the package using npm or yarn:

npm install @blockpipe/js --save

or

yarn add @blockpipe/js

Usage

1. Import BlockpipeClient and create a new instance:

import { BlockpipeClient } from "@blockpipe/js";

const client = new BlockpipeClient("YOUR_PROJECT_SLUG", {
  environment: "production", // optional
  baseUrl: "https://app.blockpipe.io/endpoint", // optional
});

2. Use the get method to fetch data from Blockpipe Endpoint API:

async function someFunction() {
  try {
    const results = await client.get(["/path1", "/path2"]);
    // do something with results[0] and results[1]

    const onlyResult = await client.get("/path");
    // if you only get one path, you can access the result directly
  } catch (e) {
    // handle error
  }
}

API

BlockpipeClient

Create a new instance of BlockpipeClient with the required configurations.

Constructor:

• project: The project slug.
• options (optional): An object with optional configurations:
  • environment: The deployment environment. Default is "production".
  • baseUrl: The base URL for the API. Default is "https://app.blockpipe.io/endpoint".

get

Fetch data from the Blockpipe Endpoint API for the specified endpoints.

Arguments:

• endpoints: An array of endpoint paths or a single endpoint path as a string.

Returns:

• A promise that resolves with an array of data fetched from the specified endpoints, or rejects with an Error object if there was an error while fetching data.

License

Apache 2.0