Repository files navigation

The Pipedream TypeScript library provides convenient access to the Pipedream API from TypeScript.

npm i -s @pipedream/sdk

A full reference for this library is availablehere.

Instantiate and use the client with the following:

import{PipedreamClient}from"@pipedream/sdk";constclient=newPipedreamClient({clientId:"YOUR_CLIENT_ID",clientSecret:"YOUR_CLIENT_SECRET",projectEnvironment:"YOUR_PROJECT_ENVIRONMENT",});awaitclient.accounts.create({app_slug:"app_slug",cfmap_json:"cfmap_json",connect_token:"connect_token",});

The SDK exports all request and response types as TypeScript interfaces. Simply import them with thefollowing namespace:

import{Pipedream}from"@pipedream/sdk";constrequest:Pipedream.AppsListRequest={    ...};

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following errorwill be thrown.

import{PipedreamError}from"@pipedream/sdk";try{awaitclient.accounts.create(...);}catch(err){if(errinstanceofPipedreamError){console.log(err.statusCode);console.log(err.message);console.log(err.body);console.log(err.rawResponse);}}

List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:

import{PipedreamClient}from"@pipedream/sdk";constclient=newPipedreamClient({clientId:"YOUR_CLIENT_ID",clientSecret:"YOUR_CLIENT_SECRET",projectEnvironment:"YOUR_PROJECT_ENVIRONMENT",});constresponse=awaitclient.apps.list();forawait(constitemofresponse){console.log(item);}// Or you can manually iterate page-by-pageletpage=awaitclient.apps.list();while(page.hasNextPage()){page=page.getNextPage();}

If you would like to send additional headers as part of the request, use theheaders request option.

constresponse=awaitclient.accounts.create(...,{headers:{'X-Custom-Header':'custom value'}});

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as longas the request is deemed retryable and the number of retry attempts has not grown larger than the configuredretry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (Internal Server Errors)

Use themaxRetries request option to configure this behavior.

constresponse=awaitclient.accounts.create(...,{maxRetries:0// override maxRetries at the request level});

The SDK defaults to a 60 second timeout. Use thetimeoutInSeconds option to configure this behavior.

constresponse=awaitclient.accounts.create(...,{timeoutInSeconds:30// override timeout to 30s});

The SDK allows users to abort requests at any point by passing in an abort signal.

constcontroller=newAbortController();constresponse=awaitclient.accounts.create(...,{abortSignal:controller.signal});controller.abort();// aborts the request

The SDK provides access to raw response data, including headers, through the.withRawResponse() method.The.withRawResponse() method returns a promise that results to an object with adata and arawResponse property.

const{ data, rawResponse}=awaitclient.accounts.create(...).withRawResponse();console.log(data);console.log(rawResponse.headers['X-My-Header']);

The SDK defaults tonode-fetch but will use the global fetch client if present. The SDK works in the followingruntimes:

• Node.js 18+
• Vercel
• Cloudflare Workers
• Deno v1.25+
• Bun 1.0+
• React Native

The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in anunsupported environment, this provides a way for you to break glass and ensure the SDK works.

import{PipedreamClient}from"@pipedream/sdk";constclient=newPipedreamClient({    ...fetcher:// provide your implementation here});

While we value open-source contributions to this SDK, this library is generated programmatically.Additions made directly to this library would have to be moved over to our generation code,otherwise they would be overwritten upon the next generated release. Feel free to open a PR asa proof of concept, but know that we will not be able to merge it as-is. We suggest openingan issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!