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 all commits
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
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1213,15 +1213,21 @@ 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.parameters` | object | URL, query, and request body parameters for the given route. |
| 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.
You can call this method directly to make other requests to the API.

The method accepts an `AbortSignal` which can be used to cancel the request in flight.

### `FileOutput`

`FileOutput` is a `ReadableStream` instance that represents a model file output. It can be used to stream file data to disk or as a `Response` body to an HTTP request.
Expand Down
114 changes: 81 additions & 33 deletions index.d.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -183,10 +183,14 @@ declare module "replicate" {
headers?: object | Headers;
params?: object;
data?: object;
signal?: AbortSignal;
}
): Promise<Response>;

paginate<T>(endpoint: () => Promise<Page<T>>): AsyncGenerator<[T]>;
paginate<T>(
endpoint: () => Promise<Page<T>>,
options?: { signal?: AbortSignal }
): AsyncGenerator<T[]>;

wait(
prediction: Prediction,
Expand All@@ -197,12 +201,15 @@ declare module "replicate" {
): Promise<Prediction>;

accounts: {
current(): Promise<Account>;
current(options?: { signal?: AbortSignal }): Promise<Account>;
};

collections: {
list(): Promise<Page<Collection>>;
get(collection_slug: string): Promise<Collection>;
list(options?: { signal?: AbortSignal }): Promise<Page<Collection>>;
get(
collection_slug: string,
options?: { signal?: AbortSignal }
): Promise<Collection>;
};

deployments: {
Expand All@@ -217,21 +224,26 @@ declare module "replicate" {
webhook?: string;
webhook_events_filter?: WebhookEventType[];
wait?: number | boolean;
signal?: AbortSignal;
}
): Promise<Prediction>;
};
get(
deployment_owner: string,
deployment_name: string
deployment_name: string,
options?: { signal?: AbortSignal }
): Promise<Deployment>;
create(
deployment_config: {
name: string;
model: string;
version: string;
hardware: string;
min_instances: number;
max_instances: number;
},
options?: { signal?: AbortSignal }
): Promise<Deployment>;
create(deployment_config: {
name: string;
model: string;
version: string;
hardware: string;
min_instances: number;
max_instances: number;
}): Promise<Deployment>;
update(
deployment_owner: string,
deployment_name: string,
Expand All@@ -245,32 +257,45 @@ declare module "replicate" {
| { hardware: string }
| { min_instances: number }
| { max_instances: number }
)
),
options?: { signal?: AbortSignal }
): Promise<Deployment>;
delete(
deployment_owner: string,
deployment_name: string
deployment_name: string,
options?: { signal?: AbortSignal }
): Promise<boolean>;
list(): Promise<Page<Deployment>>;
list(options?: { signal?: AbortSignal }): Promise<Page<Deployment>>;
};

files: {
create(
file: Blob | Buffer,
metadata?: Record<string, unknown>
metadata?: Record<string, unknown>,
options?: { signal?: AbortSignal }
): Promise<FileObject>;
list(): Promise<Page<FileObject>>;
get(file_id: string): Promise<FileObject>;
delete(file_id: string): Promise<boolean>;
list(options?: { signal?: AbortSignal }): Promise<Page<FileObject>>;
get(
file_id: string,
options?: { signal?: AbortSignal }
): Promise<FileObject>;
delete(
file_id: string,
options?: { signal?: AbortSignal }
): Promise<boolean>;
};

hardware: {
list(): Promise<Hardware[]>;
list(options?: { signal?: AbortSignal }): Promise<Hardware[]>;
};

models: {
get(model_owner: string, model_name: string): Promise<Model>;
list(): Promise<Page<Model>>;
get(
model_owner: string,
model_name: string,
options?: { signal?: AbortSignal }
): Promise<Model>;
list(options?: { signal?: AbortSignal }): Promise<Page<Model>>;
create(
model_owner: string,
model_name: string,
Expand All@@ -282,17 +307,26 @@ declare module "replicate" {
paper_url?: string;
license_url?: string;
cover_image_url?: string;
signal?: AbortSignal;
}
): Promise<Model>;
versions: {
list(model_owner: string, model_name: string): Promise<ModelVersion[]>;
list(
model_owner: string,
model_name: string,
options?: { signal?: AbortSignal }
): Promise<ModelVersion[]>;
get(
model_owner: string,
model_name: string,
version_id: string
version_id: string,
options?: { signal?: AbortSignal }
): Promise<ModelVersion>;
};
search(query: string): Promise<Page<Model>>;
search(
query: string,
options?: { signal?: AbortSignal }
): Promise<Page<Model>>;
};

predictions: {
Expand All@@ -306,11 +340,18 @@ declare module "replicate" {
webhook?: string;
webhook_events_filter?: WebhookEventType[];
wait?: boolean | number;
signal?: AbortSignal;
} & ({ version: string } | { model: string })
): Promise<Prediction>;
get(prediction_id: string): Promise<Prediction>;
cancel(prediction_id: string): Promise<Prediction>;
list(): Promise<Page<Prediction>>;
get(
prediction_id: string,
options?: { signal?: AbortSignal }
): Promise<Prediction>;
cancel(
prediction_id: string,
options?: { signal?: AbortSignal }
): Promise<Prediction>;
list(options?: { signal?: AbortSignal }): Promise<Page<Prediction>>;
};

trainings: {
Expand All@@ -323,17 +364,24 @@ declare module "replicate" {
input: object;
webhook?: string;
webhook_events_filter?: WebhookEventType[];
signal?: AbortSignal;
}
): Promise<Training>;
get(training_id: string): Promise<Training>;
cancel(training_id: string): Promise<Training>;
list(): Promise<Page<Training>>;
get(
training_id: string,
options?: { signal?: AbortSignal }
): Promise<Training>;
cancel(
training_id: string,
options?: { signal?: AbortSignal }
): Promise<Training>;
list(options?: { signal?: AbortSignal }): Promise<Page<Training>>;
};

webhooks: {
default: {
secret: {
get(): Promise<WebhookSecret>;
get(options?: { signal?: AbortSignal }): Promise<WebhookSecret>;
};
};
};
Expand Down
17 changes: 12 additions & 5 deletions index.js
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand Up@@ -273,6 +274,7 @@ class Replicate {
method,
headers,
body,
signal,
};

const shouldRetry =
Expand DownExpand Up@@ -354,15 +356,20 @@ class Replicate {
* console.log(page);
* }
* @param {Function} endpoint - Function that returns a promise for the next page of results
* @param {object} [options]
* @param {AbortSignal} [options.signal] - AbortSignal to cancel the request.
* @yields {object[]} Each page of results
*/
async *paginate(endpoint) {
async *paginate(endpoint, options = {}) {
const response = await endpoint();
yield response.results;
if (response.next) {
if (response.next && !(options.signal && options.signal.aborted)) {
const nextPage = () =>
this.request(response.next, { method: "GET" }).then((r) => r.json());
yield* this.paginate(nextPage);
this.request(response.next, {
method: "GET",
signal: options.signal,
}).then((r) => r.json());
yield* this.paginate(nextPage, options);
}
}

Expand Down
84 changes: 84 additions & 0 deletions index.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,90 @@ describe("Replicate client", () => {
});
});

describe("paginate", () => {
test("pages through results", async () => {
nock(BASE_URL)
.get("/collections")
.reply(200, {
results: [
{
name: "Super resolution",
slug: "super-resolution",
description:
"Upscaling models that create high-quality images from low-quality images.",
},
],
next: `${BASE_URL}/collections?page=2`,
previous: null,
});
nock(BASE_URL)
.get("/collections?page=2")
.reply(200, {
results: [
{
name: "Image classification",
slug: "image-classification",
description: "Models that classify images.",
},
],
next: null,
previous: null,
});

const iterator = client.paginate(client.collections.list);

const firstPage = (await iterator.next()).value;
expect(firstPage.length).toBe(1);

const secondPage = (await iterator.next()).value;
expect(secondPage.length).toBe(1);
});

test("accepts an abort signal", async () => {
nock(BASE_URL)
.get("/collections")
.reply(200, {
results: [
{
name: "Super resolution",
slug: "super-resolution",
description:
"Upscaling models that create high-quality images from low-quality images.",
},
],
next: `${BASE_URL}/collections?page=2`,
previous: null,
});
nock(BASE_URL)
.get("/collections?page=2")
.reply(200, {
results: [
{
name: "Image classification",
slug: "image-classification",
description: "Models that classify images.",
},
],
next: null,
previous: null,
});

const controller = new AbortController();
const iterator = client.paginate(client.collections.list, {
signal: controller.signal,
});

const firstIteration = await iterator.next();
expect(firstIteration.value.length).toBe(1);

controller.abort();

const secondIteration = await iterator.next();
expect(secondIteration.value).toBeUndefined();
expect(secondIteration.done).toBe(true);
});
});

describe("account.get", () => {
test("Calls the correct API route", async () => {
nock(BASE_URL).get("/account").reply(200, {
Expand Down
8 changes: 4 additions & 4 deletions integration/next/pages/index.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
export default () => (
<main>
<h1>Welcome to Next.js</h1>
</main>
)
<main>
<h1>Welcome to Next.js</h1>
</main>
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

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 all commits
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


14 changes: 10 additions & 4 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1213,15 +1213,21 @@ 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.parameters` | object | URL, query, and request body parameters for the given route. |
| 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.
You can call this method directly to make other requests to the API.

The method accepts an `AbortSignal` which can be used to cancel the request in flight.

### `FileOutput`

`FileOutput` is a `ReadableStream` instance that represents a model file output. It can be used to stream file data to disk or as a `Response` body to an HTTP request.
Expand Down

114 changes: 81 additions & 33 deletions
index.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,10 +183,14 @@ declare module "replicate" {
 headers?: object | Headers;
 params?: object;
 data?: object;
 signal?: AbortSignal;
 }
 ): Promise<Response>;

 paginate<T>(endpoint: () => Promise<Page<T>>): AsyncGenerator<[T]>;
 paginate<T>(
 endpoint: () => Promise<Page<T>>,
 options?: { signal?: AbortSignal }
 ): AsyncGenerator<T[]>;

 wait(
 prediction: Prediction,
Expand All@@ -197,12 +201,15 @@ declare module "replicate" {
 ): Promise<Prediction>;

 accounts: {
 current(): Promise<Account>;
 current(options?: { signal?: AbortSignal }): Promise<Account>;
 };

 collections: {
 list(): Promise<Page<Collection>>;
 get(collection_slug: string): Promise<Collection>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Collection>>;
 get(
 collection_slug: string,
 options?: { signal?: AbortSignal }
 ): Promise<Collection>;
 };

 deployments: {
Expand All@@ -217,21 +224,26 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: number | boolean;
 signal?: AbortSignal;
 }
 ): Promise<Prediction>;
 };
 get(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(
 deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 },
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 }): Promise<Deployment>;
 update(
 deployment_owner: string,
 deployment_name: string,
Expand All@@ -245,32 +257,45 @@ declare module "replicate" {
 | { hardware: string }
 | { min_instances: number }
 | { max_instances: number }
 )
 ),
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 delete(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 list(): Promise<Page<Deployment>>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Deployment>>;
 };

 files: {
 create(
 file: Blob | Buffer,
 metadata?: Record<string, unknown>
 metadata?: Record<string, unknown>,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 list(): Promise<Page<FileObject>>;
 get(file_id: string): Promise<FileObject>;
 delete(file_id: string): Promise<boolean>;
 list(options?: { signal?: AbortSignal }): Promise<Page<FileObject>>;
 get(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 delete(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 };

 hardware: {
 list(): Promise<Hardware[]>;
 list(options?: { signal?: AbortSignal }): Promise<Hardware[]>;
 };

 models: {
 get(model_owner: string, model_name: string): Promise<Model>;
 list(): Promise<Page<Model>>;
 get(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Model>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Model>>;
 create(
 model_owner: string,
 model_name: string,
Expand All@@ -282,17 +307,26 @@ declare module "replicate" {
 paper_url?: string;
 license_url?: string;
 cover_image_url?: string;
 signal?: AbortSignal;
 }
 ): Promise<Model>;
 versions: {
 list(model_owner: string, model_name: string): Promise<ModelVersion[]>;
 list(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion[]>;
 get(
 model_owner: string,
 model_name: string,
 version_id: string
 version_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion>;
 };
 search(query: string): Promise<Page<Model>>;
 search(
 query: string,
 options?: { signal?: AbortSignal }
 ): Promise<Page<Model>>;
 };

 predictions: {
Expand All@@ -306,11 +340,18 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: boolean | number;
 signal?: AbortSignal;
 } & ({ version: string } | { model: string })
 ): Promise<Prediction>;
 get(prediction_id: string): Promise<Prediction>;
 cancel(prediction_id: string): Promise<Prediction>;
 list(): Promise<Page<Prediction>>;
 get(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 cancel(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Prediction>>;
 };

 trainings: {
Expand All@@ -323,17 +364,24 @@ declare module "replicate" {
 input: object;
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 signal?: AbortSignal;
 }
 ): Promise<Training>;
 get(training_id: string): Promise<Training>;
 cancel(training_id: string): Promise<Training>;
 list(): Promise<Page<Training>>;
 get(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 cancel(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Training>>;
 };

 webhooks: {
 default: {
 secret: {
 get(): Promise<WebhookSecret>;
 get(options?: { signal?: AbortSignal }): Promise<WebhookSecret>;
 };
 };
 };
Expand Down

17 changes: 12 additions & 5 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff 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 DownExpand Up@@ -273,6 +274,7 @@ class Replicate {
 method,
 headers,
 body,
 signal,
 };

 const shouldRetry =
Expand DownExpand Up@@ -354,15 +356,20 @@ class Replicate {
 * console.log(page);
 * }
 * @param {Function} endpoint - Function that returns a promise for the next page of results
 * @param {object} [options]
 * @param {AbortSignal} [options.signal] - AbortSignal to cancel the request.
 * @yields {object[]} Each page of results
 */
 async *paginate(endpoint) {
 async *paginate(endpoint, options = {}) {
 const response = await endpoint();
 yield response.results;
 if (response.next) {
 if (response.next && !(options.signal && options.signal.aborted)) {
 const nextPage = () =>
 this.request(response.next, { method: "GET" }).then((r) => r.json());
 yield* this.paginate(nextPage);
 this.request(response.next, {
 method: "GET",
 signal: options.signal,
 }).then((r) => r.json());
 yield* this.paginate(nextPage, options);
 }
 }

Expand Down

84 changes: 84 additions & 0 deletions
index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,90 @@ describe("Replicate client", () => {
 });
 });

 describe("paginate", () => {
 test("pages through results", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const iterator = client.paginate(client.collections.list);

 const firstPage = (await iterator.next()).value;
 expect(firstPage.length).toBe(1);

 const secondPage = (await iterator.next()).value;
 expect(secondPage.length).toBe(1);
 });

 test("accepts an abort signal", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const controller = new AbortController();
 const iterator = client.paginate(client.collections.list, {
 signal: controller.signal,
 });

 const firstIteration = await iterator.next();
 expect(firstIteration.value.length).toBe(1);

 controller.abort();

 const secondIteration = await iterator.next();
 expect(secondIteration.value).toBeUndefined();
 expect(secondIteration.done).toBe(true);
 });
 });

 describe("account.get", () => {
 test("Calls the correct API route", async () => {
 nock(BASE_URL).get("/account").reply(200, {
Expand Down

8 changes: 4 additions & 4 deletions
integration/next/pages/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
export default () => (
<main>
<h1>Welcome to Next.js</h1>
</main>
)
<main>
<h1>Welcome to Next.js</h1>
</main>
);
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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 all commits
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


14 changes: 10 additions & 4 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1213,15 +1213,21 @@ 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.parameters` | object | URL, query, and request body parameters for the given route. |
| 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.
You can call this method directly to make other requests to the API.

The method accepts an `AbortSignal` which can be used to cancel the request in flight.

### `FileOutput`

`FileOutput` is a `ReadableStream` instance that represents a model file output. It can be used to stream file data to disk or as a `Response` body to an HTTP request.
Expand Down

114 changes: 81 additions & 33 deletions
index.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,10 +183,14 @@ declare module "replicate" {
 headers?: object | Headers;
 params?: object;
 data?: object;
 signal?: AbortSignal;
 }
 ): Promise<Response>;

 paginate<T>(endpoint: () => Promise<Page<T>>): AsyncGenerator<[T]>;
 paginate<T>(
 endpoint: () => Promise<Page<T>>,
 options?: { signal?: AbortSignal }
 ): AsyncGenerator<T[]>;

 wait(
 prediction: Prediction,
Expand All@@ -197,12 +201,15 @@ declare module "replicate" {
 ): Promise<Prediction>;

 accounts: {
 current(): Promise<Account>;
 current(options?: { signal?: AbortSignal }): Promise<Account>;
 };

 collections: {
 list(): Promise<Page<Collection>>;
 get(collection_slug: string): Promise<Collection>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Collection>>;
 get(
 collection_slug: string,
 options?: { signal?: AbortSignal }
 ): Promise<Collection>;
 };

 deployments: {
Expand All@@ -217,21 +224,26 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: number | boolean;
 signal?: AbortSignal;
 }
 ): Promise<Prediction>;
 };
 get(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(
 deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 },
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 }): Promise<Deployment>;
 update(
 deployment_owner: string,
 deployment_name: string,
Expand All@@ -245,32 +257,45 @@ declare module "replicate" {
 | { hardware: string }
 | { min_instances: number }
 | { max_instances: number }
 )
 ),
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 delete(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 list(): Promise<Page<Deployment>>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Deployment>>;
 };

 files: {
 create(
 file: Blob | Buffer,
 metadata?: Record<string, unknown>
 metadata?: Record<string, unknown>,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 list(): Promise<Page<FileObject>>;
 get(file_id: string): Promise<FileObject>;
 delete(file_id: string): Promise<boolean>;
 list(options?: { signal?: AbortSignal }): Promise<Page<FileObject>>;
 get(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 delete(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 };

 hardware: {
 list(): Promise<Hardware[]>;
 list(options?: { signal?: AbortSignal }): Promise<Hardware[]>;
 };

 models: {
 get(model_owner: string, model_name: string): Promise<Model>;
 list(): Promise<Page<Model>>;
 get(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Model>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Model>>;
 create(
 model_owner: string,
 model_name: string,
Expand All@@ -282,17 +307,26 @@ declare module "replicate" {
 paper_url?: string;
 license_url?: string;
 cover_image_url?: string;
 signal?: AbortSignal;
 }
 ): Promise<Model>;
 versions: {
 list(model_owner: string, model_name: string): Promise<ModelVersion[]>;
 list(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion[]>;
 get(
 model_owner: string,
 model_name: string,
 version_id: string
 version_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion>;
 };
 search(query: string): Promise<Page<Model>>;
 search(
 query: string,
 options?: { signal?: AbortSignal }
 ): Promise<Page<Model>>;
 };

 predictions: {
Expand All@@ -306,11 +340,18 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: boolean | number;
 signal?: AbortSignal;
 } & ({ version: string } | { model: string })
 ): Promise<Prediction>;
 get(prediction_id: string): Promise<Prediction>;
 cancel(prediction_id: string): Promise<Prediction>;
 list(): Promise<Page<Prediction>>;
 get(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 cancel(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Prediction>>;
 };

 trainings: {
Expand All@@ -323,17 +364,24 @@ declare module "replicate" {
 input: object;
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 signal?: AbortSignal;
 }
 ): Promise<Training>;
 get(training_id: string): Promise<Training>;
 cancel(training_id: string): Promise<Training>;
 list(): Promise<Page<Training>>;
 get(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 cancel(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Training>>;
 };

 webhooks: {
 default: {
 secret: {
 get(): Promise<WebhookSecret>;
 get(options?: { signal?: AbortSignal }): Promise<WebhookSecret>;
 };
 };
 };
Expand Down

17 changes: 12 additions & 5 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff 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 DownExpand Up@@ -273,6 +274,7 @@ class Replicate {
 method,
 headers,
 body,
 signal,
 };

 const shouldRetry =
Expand DownExpand Up@@ -354,15 +356,20 @@ class Replicate {
 * console.log(page);
 * }
 * @param {Function} endpoint - Function that returns a promise for the next page of results
 * @param {object} [options]
 * @param {AbortSignal} [options.signal] - AbortSignal to cancel the request.
 * @yields {object[]} Each page of results
 */
 async *paginate(endpoint) {
 async *paginate(endpoint, options = {}) {
 const response = await endpoint();
 yield response.results;
 if (response.next) {
 if (response.next && !(options.signal && options.signal.aborted)) {
 const nextPage = () =>
 this.request(response.next, { method: "GET" }).then((r) => r.json());
 yield* this.paginate(nextPage);
 this.request(response.next, {
 method: "GET",
 signal: options.signal,
 }).then((r) => r.json());
 yield* this.paginate(nextPage, options);
 }
 }

Expand Down

84 changes: 84 additions & 0 deletions
index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,90 @@ describe("Replicate client", () => {
 });
 });

 describe("paginate", () => {
 test("pages through results", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const iterator = client.paginate(client.collections.list);

 const firstPage = (await iterator.next()).value;
 expect(firstPage.length).toBe(1);

 const secondPage = (await iterator.next()).value;
 expect(secondPage.length).toBe(1);
 });

 test("accepts an abort signal", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const controller = new AbortController();
 const iterator = client.paginate(client.collections.list, {
 signal: controller.signal,
 });

 const firstIteration = await iterator.next();
 expect(firstIteration.value.length).toBe(1);

 controller.abort();

 const secondIteration = await iterator.next();
 expect(secondIteration.value).toBeUndefined();
 expect(secondIteration.done).toBe(true);
 });
 });

 describe("account.get", () => {
 test("Calls the correct API route", async () => {
 nock(BASE_URL).get("/account").reply(200, {
Expand Down

8 changes: 4 additions & 4 deletions
integration/next/pages/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
export default () => (
<main>
<h1>Welcome to Next.js</h1>
</main>
)
<main>
<h1>Welcome to Next.js</h1>
</main>
);
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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 all commits
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


14 changes: 10 additions & 4 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1213,15 +1213,21 @@ 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.parameters` | object | URL, query, and request body parameters for the given route. |
| 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.
You can call this method directly to make other requests to the API.

The method accepts an `AbortSignal` which can be used to cancel the request in flight.

### `FileOutput`

`FileOutput` is a `ReadableStream` instance that represents a model file output. It can be used to stream file data to disk or as a `Response` body to an HTTP request.
Expand Down

114 changes: 81 additions & 33 deletions
index.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,10 +183,14 @@ declare module "replicate" {
 headers?: object | Headers;
 params?: object;
 data?: object;
 signal?: AbortSignal;
 }
 ): Promise<Response>;

 paginate<T>(endpoint: () => Promise<Page<T>>): AsyncGenerator<[T]>;
 paginate<T>(
 endpoint: () => Promise<Page<T>>,
 options?: { signal?: AbortSignal }
 ): AsyncGenerator<T[]>;

 wait(
 prediction: Prediction,
Expand All@@ -197,12 +201,15 @@ declare module "replicate" {
 ): Promise<Prediction>;

 accounts: {
 current(): Promise<Account>;
 current(options?: { signal?: AbortSignal }): Promise<Account>;
 };

 collections: {
 list(): Promise<Page<Collection>>;
 get(collection_slug: string): Promise<Collection>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Collection>>;
 get(
 collection_slug: string,
 options?: { signal?: AbortSignal }
 ): Promise<Collection>;
 };

 deployments: {
Expand All@@ -217,21 +224,26 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: number | boolean;
 signal?: AbortSignal;
 }
 ): Promise<Prediction>;
 };
 get(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(
 deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 },
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 }): Promise<Deployment>;
 update(
 deployment_owner: string,
 deployment_name: string,
Expand All@@ -245,32 +257,45 @@ declare module "replicate" {
 | { hardware: string }
 | { min_instances: number }
 | { max_instances: number }
 )
 ),
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 delete(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 list(): Promise<Page<Deployment>>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Deployment>>;
 };

 files: {
 create(
 file: Blob | Buffer,
 metadata?: Record<string, unknown>
 metadata?: Record<string, unknown>,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 list(): Promise<Page<FileObject>>;
 get(file_id: string): Promise<FileObject>;
 delete(file_id: string): Promise<boolean>;
 list(options?: { signal?: AbortSignal }): Promise<Page<FileObject>>;
 get(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 delete(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 };

 hardware: {
 list(): Promise<Hardware[]>;
 list(options?: { signal?: AbortSignal }): Promise<Hardware[]>;
 };

 models: {
 get(model_owner: string, model_name: string): Promise<Model>;
 list(): Promise<Page<Model>>;
 get(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Model>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Model>>;
 create(
 model_owner: string,
 model_name: string,
Expand All@@ -282,17 +307,26 @@ declare module "replicate" {
 paper_url?: string;
 license_url?: string;
 cover_image_url?: string;
 signal?: AbortSignal;
 }
 ): Promise<Model>;
 versions: {
 list(model_owner: string, model_name: string): Promise<ModelVersion[]>;
 list(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion[]>;
 get(
 model_owner: string,
 model_name: string,
 version_id: string
 version_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion>;
 };
 search(query: string): Promise<Page<Model>>;
 search(
 query: string,
 options?: { signal?: AbortSignal }
 ): Promise<Page<Model>>;
 };

 predictions: {
Expand All@@ -306,11 +340,18 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: boolean | number;
 signal?: AbortSignal;
 } & ({ version: string } | { model: string })
 ): Promise<Prediction>;
 get(prediction_id: string): Promise<Prediction>;
 cancel(prediction_id: string): Promise<Prediction>;
 list(): Promise<Page<Prediction>>;
 get(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 cancel(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Prediction>>;
 };

 trainings: {
Expand All@@ -323,17 +364,24 @@ declare module "replicate" {
 input: object;
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 signal?: AbortSignal;
 }
 ): Promise<Training>;
 get(training_id: string): Promise<Training>;
 cancel(training_id: string): Promise<Training>;
 list(): Promise<Page<Training>>;
 get(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 cancel(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Training>>;
 };

 webhooks: {
 default: {
 secret: {
 get(): Promise<WebhookSecret>;
 get(options?: { signal?: AbortSignal }): Promise<WebhookSecret>;
 };
 };
 };
Expand Down

17 changes: 12 additions & 5 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff 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 DownExpand Up@@ -273,6 +274,7 @@ class Replicate {
 method,
 headers,
 body,
 signal,
 };

 const shouldRetry =
Expand DownExpand Up@@ -354,15 +356,20 @@ class Replicate {
 * console.log(page);
 * }
 * @param {Function} endpoint - Function that returns a promise for the next page of results
 * @param {object} [options]
 * @param {AbortSignal} [options.signal] - AbortSignal to cancel the request.
 * @yields {object[]} Each page of results
 */
 async *paginate(endpoint) {
 async *paginate(endpoint, options = {}) {
 const response = await endpoint();
 yield response.results;
 if (response.next) {
 if (response.next && !(options.signal && options.signal.aborted)) {
 const nextPage = () =>
 this.request(response.next, { method: "GET" }).then((r) => r.json());
 yield* this.paginate(nextPage);
 this.request(response.next, {
 method: "GET",
 signal: options.signal,
 }).then((r) => r.json());
 yield* this.paginate(nextPage, options);
 }
 }

Expand Down

84 changes: 84 additions & 0 deletions
index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,90 @@ describe("Replicate client", () => {
 });
 });

 describe("paginate", () => {
 test("pages through results", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const iterator = client.paginate(client.collections.list);

 const firstPage = (await iterator.next()).value;
 expect(firstPage.length).toBe(1);

 const secondPage = (await iterator.next()).value;
 expect(secondPage.length).toBe(1);
 });

 test("accepts an abort signal", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const controller = new AbortController();
 const iterator = client.paginate(client.collections.list, {
 signal: controller.signal,
 });

 const firstIteration = await iterator.next();
 expect(firstIteration.value.length).toBe(1);

 controller.abort();

 const secondIteration = await iterator.next();
 expect(secondIteration.value).toBeUndefined();
 expect(secondIteration.done).toBe(true);
 });
 });

 describe("account.get", () => {
 test("Calls the correct API route", async () => {
 nock(BASE_URL).get("/account").reply(200, {
Expand Down

8 changes: 4 additions & 4 deletions
integration/next/pages/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
export default () => (
<main>
<h1>Welcome to Next.js</h1>
</main>
)
<main>
<h1>Welcome to Next.js</h1>
</main>
);
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

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 all commits
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


14 changes: 10 additions & 4 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1213,15 +1213,21 @@ 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.parameters` | object | URL, query, and request body parameters for the given route. |
| 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.
You can call this method directly to make other requests to the API.

The method accepts an `AbortSignal` which can be used to cancel the request in flight.

### `FileOutput`

`FileOutput` is a `ReadableStream` instance that represents a model file output. It can be used to stream file data to disk or as a `Response` body to an HTTP request.
Expand Down

114 changes: 81 additions & 33 deletions
index.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,10 +183,14 @@ declare module "replicate" {
 headers?: object | Headers;
 params?: object;
 data?: object;
 signal?: AbortSignal;
 }
 ): Promise<Response>;

 paginate<T>(endpoint: () => Promise<Page<T>>): AsyncGenerator<[T]>;
 paginate<T>(
 endpoint: () => Promise<Page<T>>,
 options?: { signal?: AbortSignal }
 ): AsyncGenerator<T[]>;

 wait(
 prediction: Prediction,
Expand All@@ -197,12 +201,15 @@ declare module "replicate" {
 ): Promise<Prediction>;

 accounts: {
 current(): Promise<Account>;
 current(options?: { signal?: AbortSignal }): Promise<Account>;
 };

 collections: {
 list(): Promise<Page<Collection>>;
 get(collection_slug: string): Promise<Collection>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Collection>>;
 get(
 collection_slug: string,
 options?: { signal?: AbortSignal }
 ): Promise<Collection>;
 };

 deployments: {
Expand All@@ -217,21 +224,26 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: number | boolean;
 signal?: AbortSignal;
 }
 ): Promise<Prediction>;
 };
 get(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(
 deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 },
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 }): Promise<Deployment>;
 update(
 deployment_owner: string,
 deployment_name: string,
Expand All@@ -245,32 +257,45 @@ declare module "replicate" {
 | { hardware: string }
 | { min_instances: number }
 | { max_instances: number }
 )
 ),
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 delete(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 list(): Promise<Page<Deployment>>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Deployment>>;
 };

 files: {
 create(
 file: Blob | Buffer,
 metadata?: Record<string, unknown>
 metadata?: Record<string, unknown>,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 list(): Promise<Page<FileObject>>;
 get(file_id: string): Promise<FileObject>;
 delete(file_id: string): Promise<boolean>;
 list(options?: { signal?: AbortSignal }): Promise<Page<FileObject>>;
 get(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 delete(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 };

 hardware: {
 list(): Promise<Hardware[]>;
 list(options?: { signal?: AbortSignal }): Promise<Hardware[]>;
 };

 models: {
 get(model_owner: string, model_name: string): Promise<Model>;
 list(): Promise<Page<Model>>;
 get(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Model>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Model>>;
 create(
 model_owner: string,
 model_name: string,
Expand All@@ -282,17 +307,26 @@ declare module "replicate" {
 paper_url?: string;
 license_url?: string;
 cover_image_url?: string;
 signal?: AbortSignal;
 }
 ): Promise<Model>;
 versions: {
 list(model_owner: string, model_name: string): Promise<ModelVersion[]>;
 list(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion[]>;
 get(
 model_owner: string,
 model_name: string,
 version_id: string
 version_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion>;
 };
 search(query: string): Promise<Page<Model>>;
 search(
 query: string,
 options?: { signal?: AbortSignal }
 ): Promise<Page<Model>>;
 };

 predictions: {
Expand All@@ -306,11 +340,18 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: boolean | number;
 signal?: AbortSignal;
 } & ({ version: string } | { model: string })
 ): Promise<Prediction>;
 get(prediction_id: string): Promise<Prediction>;
 cancel(prediction_id: string): Promise<Prediction>;
 list(): Promise<Page<Prediction>>;
 get(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 cancel(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Prediction>>;
 };

 trainings: {
Expand All@@ -323,17 +364,24 @@ declare module "replicate" {
 input: object;
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 signal?: AbortSignal;
 }
 ): Promise<Training>;
 get(training_id: string): Promise<Training>;
 cancel(training_id: string): Promise<Training>;
 list(): Promise<Page<Training>>;
 get(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 cancel(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Training>>;
 };

 webhooks: {
 default: {
 secret: {
 get(): Promise<WebhookSecret>;
 get(options?: { signal?: AbortSignal }): Promise<WebhookSecret>;
 };
 };
 };
Expand Down

17 changes: 12 additions & 5 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff 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 DownExpand Up@@ -273,6 +274,7 @@ class Replicate {
 method,
 headers,
 body,
 signal,
 };

 const shouldRetry =
Expand DownExpand Up@@ -354,15 +356,20 @@ class Replicate {
 * console.log(page);
 * }
 * @param {Function} endpoint - Function that returns a promise for the next page of results
 * @param {object} [options]
 * @param {AbortSignal} [options.signal] - AbortSignal to cancel the request.
 * @yields {object[]} Each page of results
 */
 async *paginate(endpoint) {
 async *paginate(endpoint, options = {}) {
 const response = await endpoint();
 yield response.results;
 if (response.next) {
 if (response.next && !(options.signal && options.signal.aborted)) {
 const nextPage = () =>
 this.request(response.next, { method: "GET" }).then((r) => r.json());
 yield* this.paginate(nextPage);
 this.request(response.next, {
 method: "GET",
 signal: options.signal,
 }).then((r) => r.json());
 yield* this.paginate(nextPage, options);
 }
 }

Expand Down

84 changes: 84 additions & 0 deletions
index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,90 @@ describe("Replicate client", () => {
 });
 });

 describe("paginate", () => {
 test("pages through results", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const iterator = client.paginate(client.collections.list);

 const firstPage = (await iterator.next()).value;
 expect(firstPage.length).toBe(1);

 const secondPage = (await iterator.next()).value;
 expect(secondPage.length).toBe(1);
 });

 test("accepts an abort signal", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const controller = new AbortController();
 const iterator = client.paginate(client.collections.list, {
 signal: controller.signal,
 });

 const firstIteration = await iterator.next();
 expect(firstIteration.value.length).toBe(1);

 controller.abort();

 const secondIteration = await iterator.next();
 expect(secondIteration.value).toBeUndefined();
 expect(secondIteration.done).toBe(true);
 });
 });

 describe("account.get", () => {
 test("Calls the correct API route", async () => {
 nock(BASE_URL).get("/account").reply(200, {
Expand Down

8 changes: 4 additions & 4 deletions
integration/next/pages/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
export default () => (
<main>
<h1>Welcome to Next.js</h1>
</main>
)
<main>
<h1>Welcome to Next.js</h1>
</main>
);
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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 all commits
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


14 changes: 10 additions & 4 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1213,15 +1213,21 @@ 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.parameters` | object | URL, query, and request body parameters for the given route. |
| 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.
You can call this method directly to make other requests to the API.

The method accepts an `AbortSignal` which can be used to cancel the request in flight.

### `FileOutput`

`FileOutput` is a `ReadableStream` instance that represents a model file output. It can be used to stream file data to disk or as a `Response` body to an HTTP request.
Expand Down

114 changes: 81 additions & 33 deletions
index.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,10 +183,14 @@ declare module "replicate" {
 headers?: object | Headers;
 params?: object;
 data?: object;
 signal?: AbortSignal;
 }
 ): Promise<Response>;

 paginate<T>(endpoint: () => Promise<Page<T>>): AsyncGenerator<[T]>;
 paginate<T>(
 endpoint: () => Promise<Page<T>>,
 options?: { signal?: AbortSignal }
 ): AsyncGenerator<T[]>;

 wait(
 prediction: Prediction,
Expand All@@ -197,12 +201,15 @@ declare module "replicate" {
 ): Promise<Prediction>;

 accounts: {
 current(): Promise<Account>;
 current(options?: { signal?: AbortSignal }): Promise<Account>;
 };

 collections: {
 list(): Promise<Page<Collection>>;
 get(collection_slug: string): Promise<Collection>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Collection>>;
 get(
 collection_slug: string,
 options?: { signal?: AbortSignal }
 ): Promise<Collection>;
 };

 deployments: {
Expand All@@ -217,21 +224,26 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: number | boolean;
 signal?: AbortSignal;
 }
 ): Promise<Prediction>;
 };
 get(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(
 deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 },
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 }): Promise<Deployment>;
 update(
 deployment_owner: string,
 deployment_name: string,
Expand All@@ -245,32 +257,45 @@ declare module "replicate" {
 | { hardware: string }
 | { min_instances: number }
 | { max_instances: number }
 )
 ),
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 delete(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 list(): Promise<Page<Deployment>>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Deployment>>;
 };

 files: {
 create(
 file: Blob | Buffer,
 metadata?: Record<string, unknown>
 metadata?: Record<string, unknown>,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 list(): Promise<Page<FileObject>>;
 get(file_id: string): Promise<FileObject>;
 delete(file_id: string): Promise<boolean>;
 list(options?: { signal?: AbortSignal }): Promise<Page<FileObject>>;
 get(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 delete(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 };

 hardware: {
 list(): Promise<Hardware[]>;
 list(options?: { signal?: AbortSignal }): Promise<Hardware[]>;
 };

 models: {
 get(model_owner: string, model_name: string): Promise<Model>;
 list(): Promise<Page<Model>>;
 get(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Model>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Model>>;
 create(
 model_owner: string,
 model_name: string,
Expand All@@ -282,17 +307,26 @@ declare module "replicate" {
 paper_url?: string;
 license_url?: string;
 cover_image_url?: string;
 signal?: AbortSignal;
 }
 ): Promise<Model>;
 versions: {
 list(model_owner: string, model_name: string): Promise<ModelVersion[]>;
 list(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion[]>;
 get(
 model_owner: string,
 model_name: string,
 version_id: string
 version_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion>;
 };
 search(query: string): Promise<Page<Model>>;
 search(
 query: string,
 options?: { signal?: AbortSignal }
 ): Promise<Page<Model>>;
 };

 predictions: {
Expand All@@ -306,11 +340,18 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: boolean | number;
 signal?: AbortSignal;
 } & ({ version: string } | { model: string })
 ): Promise<Prediction>;
 get(prediction_id: string): Promise<Prediction>;
 cancel(prediction_id: string): Promise<Prediction>;
 list(): Promise<Page<Prediction>>;
 get(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 cancel(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Prediction>>;
 };

 trainings: {
Expand All@@ -323,17 +364,24 @@ declare module "replicate" {
 input: object;
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 signal?: AbortSignal;
 }
 ): Promise<Training>;
 get(training_id: string): Promise<Training>;
 cancel(training_id: string): Promise<Training>;
 list(): Promise<Page<Training>>;
 get(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 cancel(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Training>>;
 };

 webhooks: {
 default: {
 secret: {
 get(): Promise<WebhookSecret>;
 get(options?: { signal?: AbortSignal }): Promise<WebhookSecret>;
 };
 };
 };
Expand Down

17 changes: 12 additions & 5 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff 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 DownExpand Up@@ -273,6 +274,7 @@ class Replicate {
 method,
 headers,
 body,
 signal,
 };

 const shouldRetry =
Expand DownExpand Up@@ -354,15 +356,20 @@ class Replicate {
 * console.log(page);
 * }
 * @param {Function} endpoint - Function that returns a promise for the next page of results
 * @param {object} [options]
 * @param {AbortSignal} [options.signal] - AbortSignal to cancel the request.
 * @yields {object[]} Each page of results
 */
 async *paginate(endpoint) {
 async *paginate(endpoint, options = {}) {
 const response = await endpoint();
 yield response.results;
 if (response.next) {
 if (response.next && !(options.signal && options.signal.aborted)) {
 const nextPage = () =>
 this.request(response.next, { method: "GET" }).then((r) => r.json());
 yield* this.paginate(nextPage);
 this.request(response.next, {
 method: "GET",
 signal: options.signal,
 }).then((r) => r.json());
 yield* this.paginate(nextPage, options);
 }
 }

Expand Down

84 changes: 84 additions & 0 deletions
index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,90 @@ describe("Replicate client", () => {
 });
 });

 describe("paginate", () => {
 test("pages through results", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const iterator = client.paginate(client.collections.list);

 const firstPage = (await iterator.next()).value;
 expect(firstPage.length).toBe(1);

 const secondPage = (await iterator.next()).value;
 expect(secondPage.length).toBe(1);
 });

 test("accepts an abort signal", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const controller = new AbortController();
 const iterator = client.paginate(client.collections.list, {
 signal: controller.signal,
 });

 const firstIteration = await iterator.next();
 expect(firstIteration.value.length).toBe(1);

 controller.abort();

 const secondIteration = await iterator.next();
 expect(secondIteration.value).toBeUndefined();
 expect(secondIteration.done).toBe(true);
 });
 });

 describe("account.get", () => {
 test("Calls the correct API route", async () => {
 nock(BASE_URL).get("/account").reply(200, {
Expand Down

8 changes: 4 additions & 4 deletions
integration/next/pages/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
export default () => (
<main>
<h1>Welcome to Next.js</h1>
</main>
)
<main>
<h1>Welcome to Next.js</h1>
</main>
);
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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 all commits
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


14 changes: 10 additions & 4 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1213,15 +1213,21 @@ 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.parameters` | object | URL, query, and request body parameters for the given route. |
| 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.
You can call this method directly to make other requests to the API.

The method accepts an `AbortSignal` which can be used to cancel the request in flight.

### `FileOutput`

`FileOutput` is a `ReadableStream` instance that represents a model file output. It can be used to stream file data to disk or as a `Response` body to an HTTP request.
Expand Down

114 changes: 81 additions & 33 deletions
index.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,10 +183,14 @@ declare module "replicate" {
 headers?: object | Headers;
 params?: object;
 data?: object;
 signal?: AbortSignal;
 }
 ): Promise<Response>;

 paginate<T>(endpoint: () => Promise<Page<T>>): AsyncGenerator<[T]>;
 paginate<T>(
 endpoint: () => Promise<Page<T>>,
 options?: { signal?: AbortSignal }
 ): AsyncGenerator<T[]>;

 wait(
 prediction: Prediction,
Expand All@@ -197,12 +201,15 @@ declare module "replicate" {
 ): Promise<Prediction>;

 accounts: {
 current(): Promise<Account>;
 current(options?: { signal?: AbortSignal }): Promise<Account>;
 };

 collections: {
 list(): Promise<Page<Collection>>;
 get(collection_slug: string): Promise<Collection>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Collection>>;
 get(
 collection_slug: string,
 options?: { signal?: AbortSignal }
 ): Promise<Collection>;
 };

 deployments: {
Expand All@@ -217,21 +224,26 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: number | boolean;
 signal?: AbortSignal;
 }
 ): Promise<Prediction>;
 };
 get(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(
 deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 },
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 }): Promise<Deployment>;
 update(
 deployment_owner: string,
 deployment_name: string,
Expand All@@ -245,32 +257,45 @@ declare module "replicate" {
 | { hardware: string }
 | { min_instances: number }
 | { max_instances: number }
 )
 ),
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 delete(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 list(): Promise<Page<Deployment>>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Deployment>>;
 };

 files: {
 create(
 file: Blob | Buffer,
 metadata?: Record<string, unknown>
 metadata?: Record<string, unknown>,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 list(): Promise<Page<FileObject>>;
 get(file_id: string): Promise<FileObject>;
 delete(file_id: string): Promise<boolean>;
 list(options?: { signal?: AbortSignal }): Promise<Page<FileObject>>;
 get(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 delete(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 };

 hardware: {
 list(): Promise<Hardware[]>;
 list(options?: { signal?: AbortSignal }): Promise<Hardware[]>;
 };

 models: {
 get(model_owner: string, model_name: string): Promise<Model>;
 list(): Promise<Page<Model>>;
 get(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Model>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Model>>;
 create(
 model_owner: string,
 model_name: string,
Expand All@@ -282,17 +307,26 @@ declare module "replicate" {
 paper_url?: string;
 license_url?: string;
 cover_image_url?: string;
 signal?: AbortSignal;
 }
 ): Promise<Model>;
 versions: {
 list(model_owner: string, model_name: string): Promise<ModelVersion[]>;
 list(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion[]>;
 get(
 model_owner: string,
 model_name: string,
 version_id: string
 version_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion>;
 };
 search(query: string): Promise<Page<Model>>;
 search(
 query: string,
 options?: { signal?: AbortSignal }
 ): Promise<Page<Model>>;
 };

 predictions: {
Expand All@@ -306,11 +340,18 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: boolean | number;
 signal?: AbortSignal;
 } & ({ version: string } | { model: string })
 ): Promise<Prediction>;
 get(prediction_id: string): Promise<Prediction>;
 cancel(prediction_id: string): Promise<Prediction>;
 list(): Promise<Page<Prediction>>;
 get(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 cancel(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Prediction>>;
 };

 trainings: {
Expand All@@ -323,17 +364,24 @@ declare module "replicate" {
 input: object;
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 signal?: AbortSignal;
 }
 ): Promise<Training>;
 get(training_id: string): Promise<Training>;
 cancel(training_id: string): Promise<Training>;
 list(): Promise<Page<Training>>;
 get(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 cancel(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Training>>;
 };

 webhooks: {
 default: {
 secret: {
 get(): Promise<WebhookSecret>;
 get(options?: { signal?: AbortSignal }): Promise<WebhookSecret>;
 };
 };
 };
Expand Down

17 changes: 12 additions & 5 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff 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 DownExpand Up@@ -273,6 +274,7 @@ class Replicate {
 method,
 headers,
 body,
 signal,
 };

 const shouldRetry =
Expand DownExpand Up@@ -354,15 +356,20 @@ class Replicate {
 * console.log(page);
 * }
 * @param {Function} endpoint - Function that returns a promise for the next page of results
 * @param {object} [options]
 * @param {AbortSignal} [options.signal] - AbortSignal to cancel the request.
 * @yields {object[]} Each page of results
 */
 async *paginate(endpoint) {
 async *paginate(endpoint, options = {}) {
 const response = await endpoint();
 yield response.results;
 if (response.next) {
 if (response.next && !(options.signal && options.signal.aborted)) {
 const nextPage = () =>
 this.request(response.next, { method: "GET" }).then((r) => r.json());
 yield* this.paginate(nextPage);
 this.request(response.next, {
 method: "GET",
 signal: options.signal,
 }).then((r) => r.json());
 yield* this.paginate(nextPage, options);
 }
 }

Expand Down

84 changes: 84 additions & 0 deletions
index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,90 @@ describe("Replicate client", () => {
 });
 });

 describe("paginate", () => {
 test("pages through results", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const iterator = client.paginate(client.collections.list);

 const firstPage = (await iterator.next()).value;
 expect(firstPage.length).toBe(1);

 const secondPage = (await iterator.next()).value;
 expect(secondPage.length).toBe(1);
 });

 test("accepts an abort signal", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const controller = new AbortController();
 const iterator = client.paginate(client.collections.list, {
 signal: controller.signal,
 });

 const firstIteration = await iterator.next();
 expect(firstIteration.value.length).toBe(1);

 controller.abort();

 const secondIteration = await iterator.next();
 expect(secondIteration.value).toBeUndefined();
 expect(secondIteration.done).toBe(true);
 });
 });

 describe("account.get", () => {
 test("Calls the correct API route", async () => {
 nock(BASE_URL).get("/account").reply(200, {
Expand Down

8 changes: 4 additions & 4 deletions
integration/next/pages/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
export default () => (
<main>
<h1>Welcome to Next.js</h1>
</main>
)
<main>
<h1>Welcome to Next.js</h1>
</main>
);
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

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 all commits
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


14 changes: 10 additions & 4 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1213,15 +1213,21 @@ 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.parameters` | object | URL, query, and request body parameters for the given route. |
| 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.
You can call this method directly to make other requests to the API.

The method accepts an `AbortSignal` which can be used to cancel the request in flight.

### `FileOutput`

`FileOutput` is a `ReadableStream` instance that represents a model file output. It can be used to stream file data to disk or as a `Response` body to an HTTP request.
Expand Down

114 changes: 81 additions & 33 deletions
index.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -183,10 +183,14 @@ declare module "replicate" {
 headers?: object | Headers;
 params?: object;
 data?: object;
 signal?: AbortSignal;
 }
 ): Promise<Response>;

 paginate<T>(endpoint: () => Promise<Page<T>>): AsyncGenerator<[T]>;
 paginate<T>(
 endpoint: () => Promise<Page<T>>,
 options?: { signal?: AbortSignal }
 ): AsyncGenerator<T[]>;

 wait(
 prediction: Prediction,
Expand All@@ -197,12 +201,15 @@ declare module "replicate" {
 ): Promise<Prediction>;

 accounts: {
 current(): Promise<Account>;
 current(options?: { signal?: AbortSignal }): Promise<Account>;
 };

 collections: {
 list(): Promise<Page<Collection>>;
 get(collection_slug: string): Promise<Collection>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Collection>>;
 get(
 collection_slug: string,
 options?: { signal?: AbortSignal }
 ): Promise<Collection>;
 };

 deployments: {
Expand All@@ -217,21 +224,26 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: number | boolean;
 signal?: AbortSignal;
 }
 ): Promise<Prediction>;
 };
 get(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(
 deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 },
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 create(deployment_config: {
 name: string;
 model: string;
 version: string;
 hardware: string;
 min_instances: number;
 max_instances: number;
 }): Promise<Deployment>;
 update(
 deployment_owner: string,
 deployment_name: string,
Expand All@@ -245,32 +257,45 @@ declare module "replicate" {
 | { hardware: string }
 | { min_instances: number }
 | { max_instances: number }
 )
 ),
 options?: { signal?: AbortSignal }
 ): Promise<Deployment>;
 delete(
 deployment_owner: string,
 deployment_name: string
 deployment_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 list(): Promise<Page<Deployment>>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Deployment>>;
 };

 files: {
 create(
 file: Blob | Buffer,
 metadata?: Record<string, unknown>
 metadata?: Record<string, unknown>,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 list(): Promise<Page<FileObject>>;
 get(file_id: string): Promise<FileObject>;
 delete(file_id: string): Promise<boolean>;
 list(options?: { signal?: AbortSignal }): Promise<Page<FileObject>>;
 get(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<FileObject>;
 delete(
 file_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<boolean>;
 };

 hardware: {
 list(): Promise<Hardware[]>;
 list(options?: { signal?: AbortSignal }): Promise<Hardware[]>;
 };

 models: {
 get(model_owner: string, model_name: string): Promise<Model>;
 list(): Promise<Page<Model>>;
 get(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<Model>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Model>>;
 create(
 model_owner: string,
 model_name: string,
Expand All@@ -282,17 +307,26 @@ declare module "replicate" {
 paper_url?: string;
 license_url?: string;
 cover_image_url?: string;
 signal?: AbortSignal;
 }
 ): Promise<Model>;
 versions: {
 list(model_owner: string, model_name: string): Promise<ModelVersion[]>;
 list(
 model_owner: string,
 model_name: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion[]>;
 get(
 model_owner: string,
 model_name: string,
 version_id: string
 version_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<ModelVersion>;
 };
 search(query: string): Promise<Page<Model>>;
 search(
 query: string,
 options?: { signal?: AbortSignal }
 ): Promise<Page<Model>>;
 };

 predictions: {
Expand All@@ -306,11 +340,18 @@ declare module "replicate" {
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 wait?: boolean | number;
 signal?: AbortSignal;
 } & ({ version: string } | { model: string })
 ): Promise<Prediction>;
 get(prediction_id: string): Promise<Prediction>;
 cancel(prediction_id: string): Promise<Prediction>;
 list(): Promise<Page<Prediction>>;
 get(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 cancel(
 prediction_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Prediction>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Prediction>>;
 };

 trainings: {
Expand All@@ -323,17 +364,24 @@ declare module "replicate" {
 input: object;
 webhook?: string;
 webhook_events_filter?: WebhookEventType[];
 signal?: AbortSignal;
 }
 ): Promise<Training>;
 get(training_id: string): Promise<Training>;
 cancel(training_id: string): Promise<Training>;
 list(): Promise<Page<Training>>;
 get(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 cancel(
 training_id: string,
 options?: { signal?: AbortSignal }
 ): Promise<Training>;
 list(options?: { signal?: AbortSignal }): Promise<Page<Training>>;
 };

 webhooks: {
 default: {
 secret: {
 get(): Promise<WebhookSecret>;
 get(options?: { signal?: AbortSignal }): Promise<WebhookSecret>;
 };
 };
 };
Expand Down

17 changes: 12 additions & 5 deletions
index.js

View file


Open in desktop

Original file line numberDiff line numberDiff 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 DownExpand Up@@ -273,6 +274,7 @@ class Replicate {
 method,
 headers,
 body,
 signal,
 };

 const shouldRetry =
Expand DownExpand Up@@ -354,15 +356,20 @@ class Replicate {
 * console.log(page);
 * }
 * @param {Function} endpoint - Function that returns a promise for the next page of results
 * @param {object} [options]
 * @param {AbortSignal} [options.signal] - AbortSignal to cancel the request.
 * @yields {object[]} Each page of results
 */
 async *paginate(endpoint) {
 async *paginate(endpoint, options = {}) {
 const response = await endpoint();
 yield response.results;
 if (response.next) {
 if (response.next && !(options.signal && options.signal.aborted)) {
 const nextPage = () =>
 this.request(response.next, { method: "GET" }).then((r) => r.json());
 yield* this.paginate(nextPage);
 this.request(response.next, {
 method: "GET",
 signal: options.signal,
 }).then((r) => r.json());
 yield* this.paginate(nextPage, options);
 }
 }

Expand Down

84 changes: 84 additions & 0 deletions
index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,90 @@ describe("Replicate client", () => {
 });
 });

 describe("paginate", () => {
 test("pages through results", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const iterator = client.paginate(client.collections.list);

 const firstPage = (await iterator.next()).value;
 expect(firstPage.length).toBe(1);

 const secondPage = (await iterator.next()).value;
 expect(secondPage.length).toBe(1);
 });

 test("accepts an abort signal", async () => {
 nock(BASE_URL)
 .get("/collections")
 .reply(200, {
 results: [
 {
 name: "Super resolution",
 slug: "super-resolution",
 description:
 "Upscaling models that create high-quality images from low-quality images.",
 },
 ],
 next: `${BASE_URL}/collections?page=2`,
 previous: null,
 });
 nock(BASE_URL)
 .get("/collections?page=2")
 .reply(200, {
 results: [
 {
 name: "Image classification",
 slug: "image-classification",
 description: "Models that classify images.",
 },
 ],
 next: null,
 previous: null,
 });

 const controller = new AbortController();
 const iterator = client.paginate(client.collections.list, {
 signal: controller.signal,
 });

 const firstIteration = await iterator.next();
 expect(firstIteration.value.length).toBe(1);

 controller.abort();

 const secondIteration = await iterator.next();
 expect(secondIteration.value).toBeUndefined();
 expect(secondIteration.done).toBe(true);
 });
 });

 describe("account.get", () => {
 test("Calls the correct API route", async () => {
 nock(BASE_URL).get("/account").reply(200, {
Expand Down

8 changes: 4 additions & 4 deletions
integration/next/pages/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
export default () => (
<main>
<h1>Welcome to Next.js</h1>
</main>
)
<main>
<h1>Welcome to Next.js</h1>
</main>
);
Loading