Skip to content

Adds abort signal to requests #368

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

Open
francislavoie wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Adds abort signal to requests #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8bb873d
Adds abort signal to requests
francislavoie Dec 9, 2025
0bf521e
use bun install, drop package-lock.json again
francislavoie Dec 10, 2025
98d225b
Move timeout/signal to Options struct
francislavoie Dec 16, 2025
2eba1ea
Re-introduce backwards compat for numeric timeout 2nd arg
francislavoie Dec 16, 2025
c7b2c2f
Switch transport to an options struct
francislavoie Dec 16, 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
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,40 @@ main().then(() => {

</details>

<details>
<summary>AbortController</summary>

```javascript
import { RequestManager, Client, HTTPTransport, AbortError } from "@open-rpc/client-js";

const transport = new HTTPTransport("http://localhost:3333");
const requestManager = new RequestManager([transport]);
const client = new Client(requestManager);

const main = async () => {
const controller = new AbortController();
const signal = controller.signal;

setTimeout(() => {
controller.abort();
}, 100);

try {
await client.request({ method: "long_running_method", params: [] }, { timeout: 5000, signal });
} catch (e) {
if (e instanceof AbortError) {
console.log("Request was aborted");
} else {
console.error(e);
}
}
};

main();
```

</details>

### Building

```sh
Expand Down
1 change: 1 addition & 0 deletions bun.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading