Skip to content

Add support for AbortSignal to all API methods #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aron merged 7 commits into from
Mar 26, 2025
+326 −82
Merged

Add support for AbortSignal to all API methods #339

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f32e187
Support passing AbortSignal into `request()`
aron Feb 5, 2025
e67b32a
Support passing AbortSignal into `paginate()`
aron Feb 5, 2025
748cb14
Fix formatting
aron Feb 5, 2025
5726051
Fix return types in utils.js
aron Feb 5, 2025
38bc74f
Add support for AbortSignal to all API methods
aron Feb 5, 2025
6c0a5c8
README formatting
aron Mar 26, 2025
68919a5
Update README.md to fix table rendering
aron Mar 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
README formatting
  • Loading branch information
@aron
aron committed Mar 26, 2025
commit 6c0a5c8ffc4fec8db6e0a4f4df891f2023691b39
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1213,14 +1213,14 @@ Low-level method used by the Replicate client to interact with API endpoints.
const response = await replicate.request(route, parameters);
```

| name | type | description |
| -------------------- | ------ | ------------------------------------------------------------ |
| `options.route` | `string` | Required. REST API endpoint path. |
| `options.params` | `object` | URL query parameters for the given route. |
| `options.method` | `string` | HTTP method for the given route. |
| `options.headers` | `object` | Additional HTTP headers for the given route. |
| `options.data` | `object | FormData` | Request body. |
| `options.signal` | `AbortSignal` | Optional `AbortSignal`. |
| name | type | description |
| -------------------- | ------------------- | ----------- |
| `options.route` | `string` | Required. REST API endpoint path.
| `options.params` | `object` | URL query parameters for the given route. |
| `options.method` | `string` | HTTP method for the given route. |
| `options.headers` | `object` | Additional HTTP headers for the given route. |
| `options.data` | `object | FormData` | Request body. |
| `options.signal` | `AbortSignal` | Optional `AbortSignal`. |

The `replicate.request()` method is used by the other methods
to interact with the Replicate API.
Expand Down