[](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FPipedreamHQ%2Fpipedream-sdk-typescript) [
The Pipedream TypeScript library provides convenient access to the Pipedream APIs from TypeScript.
- Installation
- Reference
- Migration From V 1 X
- Usage
- Request and Response Types
- Exception Handling
- Binary Response
- Pagination
- Advanced
- Additional Headers
- Additional Query String Parameters
- Retries
- Timeouts
- Aborting Requests
- Access Raw Response Data
- Runtime Compatibility
- Contributing
``sh`
npm i -s @pipedream/sdk
A full reference for this library is available here.
If you are migrating from the v1.x SDK, please refer to the migration
guide for details on how to update your code.
Instantiate and use the client with the following:
`typescript
import { PipedreamClient } from "@pipedream/sdk";
const client = new PipedreamClient({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET", projectEnvironment: "YOUR_PROJECT_ENVIRONMENT", projectId: "YOUR_PROJECT_ID" });
await client.actions.run({
id: "id",
externalUserId: "external_user_id"
});
`
The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
following namespace:
`typescript
import { Pipedream } from "@pipedream/sdk";
const request: Pipedream.AppsListRequest = {
...
};
`
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
will be thrown.
`typescript
import { PipedreamError } from "@pipedream/sdk";
try {
await client.actions.run(...);
} catch (err) {
if (err instanceof PipedreamError) {
console.log(err.statusCode);
console.log(err.message);
console.log(err.body);
console.log(err.rawResponse);
}
}
`
You can consume binary data from endpoints using the BinaryResponse type which lets you choose how to consume the data:
`typescript`
const response = await client.fileStash.downloadFile(...);
const stream: ReadableStream
// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
// const blob: Blob = response.blob();
// const bytes: Uint8Array = response.bytes();
// You can only use the response body once, so you must choose one of the above methods.
// If you want to check if the response body has been used, you can use the following property.
const bodyUsed = response.bodyUsed;Save binary response to a file
Node.js
ReadableStream (most-efficient)
`
ts
import { createWriteStream } from 'fs';
import { Readable } from 'stream';
import { pipeline } from 'stream/promises';const response = await client.fileStash.downloadFile(...);
const stream = response.stream();
const nodeStream = Readable.fromWeb(stream);
const writeStream = createWriteStream('path/to/file');await pipeline(nodeStream, writeStream);
`ArrayBuffer
`
ts
import { writeFile } from 'fs/promises';const response = await client.fileStash.downloadFile(...);
const arrayBuffer = await response.arrayBuffer();
await writeFile('path/to/file', Buffer.from(arrayBuffer));
`Blob
`
ts
import { writeFile } from 'fs/promises';const response = await client.fileStash.downloadFile(...);
const blob = await response.blob();
const arrayBuffer = await blob.arrayBuffer();
await writeFile('output.bin', Buffer.from(arrayBuffer));
`Bytes (UIntArray8)
`
ts
import { writeFile } from 'fs/promises';const response = await client.fileStash.downloadFile(...);
const bytes = await response.bytes();
await writeFile('path/to/file', bytes);
`
Bun
ReadableStream (most-efficient)
`
ts
const response = await client.fileStash.downloadFile(...);const stream = response.stream();
await Bun.write('path/to/file', stream);
`ArrayBuffer
`
ts
const response = await client.fileStash.downloadFile(...);const arrayBuffer = await response.arrayBuffer();
await Bun.write('path/to/file', arrayBuffer);
`Blob
`
ts
const response = await client.fileStash.downloadFile(...);const blob = await response.blob();
await Bun.write('path/to/file', blob);
`Bytes (UIntArray8)
`
ts
const response = await client.fileStash.downloadFile(...);const bytes = await response.bytes();
await Bun.write('path/to/file', bytes);
`
Deno
ReadableStream (most-efficient)
`
ts
const response = await client.fileStash.downloadFile(...);const stream = response.stream();
const file = await Deno.open('path/to/file', { write: true, create: true });
await stream.pipeTo(file.writable);
`ArrayBuffer
`
ts
const response = await client.fileStash.downloadFile(...);const arrayBuffer = await response.arrayBuffer();
await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
`Blob
`
ts
const response = await client.fileStash.downloadFile(...);const blob = await response.blob();
const arrayBuffer = await blob.arrayBuffer();
await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
`Bytes (UIntArray8)
`
ts
const response = await client.fileStash.downloadFile(...);const bytes = await response.bytes();
await Deno.writeFile('path/to/file', bytes);
`
Browser
Blob (most-efficient)
`
ts
const response = await client.fileStash.downloadFile(...);const blob = await response.blob();
const url = URL.createObjectURL(blob);// trigger download
const a = document.createElement('a');
a.href = url;
a.download = 'filename';
a.click();
URL.revokeObjectURL(url);
`ReadableStream
`
ts
const response = await client.fileStash.downloadFile(...);const stream = response.stream();
const reader = stream.getReader();
const chunks = [];while (true) {
const { done, value } = await reader.read();
if (done) break;
chunks.push(value);
}const blob = new Blob(chunks);
const url = URL.createObjectURL(blob);// trigger download
const a = document.createElement('a');
a.href = url;
a.download = 'filename';
a.click();
URL.revokeObjectURL(url);
`ArrayBuffer
`
ts
const response = await client.fileStash.downloadFile(...);const arrayBuffer = await response.arrayBuffer();
const blob = new Blob([arrayBuffer]);
const url = URL.createObjectURL(blob);// trigger download
const a = document.createElement('a');
a.href = url;
a.download = 'filename';
a.click();
URL.revokeObjectURL(url);
`Bytes (UIntArray8)
`
ts
const response = await client.fileStash.downloadFile(...);const bytes = await response.bytes();
const blob = new Blob([bytes]);
const url = URL.createObjectURL(blob);// trigger download
const a = document.createElement('a');
a.href = url;
a.download = 'filename';
a.click();
URL.revokeObjectURL(url);
`
Convert binary response to text
ReadableStream
`
ts
const response = await client.fileStash.downloadFile(...);const stream = response.stream();
const text = await new Response(stream).text();
`
ArrayBuffer
`
ts
const response = await client.fileStash.downloadFile(...);const arrayBuffer = await response.arrayBuffer();
const text = new TextDecoder().decode(arrayBuffer);
`
Blob
`
ts
const response = await client.fileStash.downloadFile(...);const blob = await response.blob();
const text = await blob.text();
`
Bytes (UIntArray8)
`
ts
const response = await client.fileStash.downloadFile(...);const bytes = await response.bytes();
const text = new TextDecoder().decode(bytes);
`
List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:
`typescript
import { PipedreamClient } from "@pipedream/sdk";
const client = new PipedreamClient({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET", projectEnvironment: "YOUR_PROJECT_ENVIRONMENT", projectId: "YOUR_PROJECT_ID" });
const response = await client.apps.list({
after: "after",
before: "before",
limit: 1,
q: "q",
sortKey: "name",
sortDirection: "asc",
hasComponents: true,
hasActions: true,
hasTriggers: true
});
for await (const item of response) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.apps.list({
after: "after",
before: "before",
limit: 1,
q: "q",
sortKey: "name",
sortDirection: "asc",
hasComponents: true,
hasActions: true,
hasTriggers: true
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
`
If you would like to send additional headers as part of the request, use the headers request option.
`typescript`
const response = await client.actions.run(..., {
headers: {
'X-Custom-Header': 'custom value'
}
});
If you would like to send additional query string parameters as part of the request, use the queryParams request option.
`typescript`
const response = await client.actions.run(..., {
queryParams: {
'customQueryParamKey': 'custom query param value'
}
});
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
retry 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 the maxRetries request option to configure this behavior.
`typescript`
const response = await client.actions.run(..., {
maxRetries: 0 // override maxRetries at the request level
});
The SDK defaults to a 60 second timeout. Use the timeoutInSeconds option to configure this behavior.
`typescript`
const response = await client.actions.run(..., {
timeoutInSeconds: 30 // override timeout to 30s
});
The SDK allows users to abort requests at any point by passing in an abort signal.
`typescript`
const controller = new AbortController();
const response = await client.actions.run(..., {
abortSignal: controller.signal
});
controller.abort(); // aborts the request
The SDK provides access to raw response data, including headers, through the .withRawResponse() method..withRawResponse()
The method returns a promise that results to an object with a data and a rawResponse property.
`typescript
const { data, rawResponse } = await client.actions.run(...).withRawResponse();
console.log(data);
console.log(rawResponse.headers['X-My-Header']);
`
The SDK works in the following runtimes:
- 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 an
unsupported environment, this provides a way for you to break glass and ensure the SDK works.
`typescript
import { PipedreamClient } from "@pipedream/sdk";
const client = new PipedreamClient({
...
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 as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!