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
Merged

Add support for AbortSignal to all API methods #339

Show file tree
Hide file tree
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
Next Next commit
Support passing AbortSignal into request()
  • Loading branch information
@aron
aron committed Mar 26, 2025
commit f32e187ebcae9dff3f172f143dec70388fc1fcb1
1 change: 1 addition & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ declare module "replicate" {
headers?: object | Headers;
params?: object;
data?: object;
signal?: AbortSignal;
}
): Promise<Response>;

Expand Down
4 changes: 3 additions & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,7 @@ class Replicate {
* @param {object} [options.params] - Query parameters
* @param {object|Headers} [options.headers] - HTTP headers
* @param {object} [options.data] - Body parameters
* @param {AbortSignal} [options.signal] - AbortSignal to cancel the request
* @returns {Promise<Response>} - Resolves with the response object
* @throws {ApiError} If the request failed
*/
Expand All @@ -241,7 +242,7 @@ class Replicate {
);
}

const { method = "GET", params = {}, data } = options;
const { method = "GET", params = {}, data, signal } = options;

for (const [key, value] of Object.entries(params)) {
url.searchParams.append(key, value);
Expand Down Expand Up @@ -273,6 +274,7 @@ class Replicate {
method,
headers,
body,
signal,
};

const shouldRetry =
Expand Down