@flowcore/sdk

Flowcore SDK


License
MIT
Install
npm install @flowcore/sdk@1.5.0

Documentation

Flowcore SDK

This is the Flowcore SDK, a TypeScript library for interacting with the Flowcore API.

Installation

# npm / yarn
npx jsr add @flowcore/sdk

# Deno
deno add jsr:@flowcore/sdk

Examples

Execute a command

import { DataCoreFetchByNameCommand, FlowcoreClient } from "@flowcore/sdk"
// With a bearer token
const client = new FlowcoreClient({
  getBearerToken: async (): Promise<string> => {
    const token = await someMethodToGetToken()
    return token
  },
})

// With an api key
const client = new FlowcoreClient({
  apiKeyId: "my-api-key-id",
  apiKey: "my-api-key",
})

// With retry
// NOTE! When retry is not set it will default to 250ms delay and 3 max retries.
//       To disable retry set retry to null.
const client = new FlowcoreClient({
  apiKeyId: "my-api-key-id",
  apiKey: "my-api-key",
  retry: {
    delay: 100,
    maxRetries: 5,
  },
})

// Execute a command
const command = new DataCoreFetchCommand({
  dataCoreId: "my-data-core-id",
})

const result = await client.execute(command)