-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
42fbdbe
commit 609bfed
Showing
27 changed files
with
282 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
"async-call-rpc": patch | ||
--- | ||
|
||
publish on jsr registry |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import { readFile, writeFile } from 'node:fs/promises' | ||
|
||
const jsr_path = new URL('../jsr.json', import.meta.url) | ||
const jsr = await readFile(jsr_path, 'utf8') | ||
const { version } = JSON.parse(await readFile(new URL('../package.json', import.meta.url), 'utf8')) | ||
|
||
await writeFile(jsr_path, jsr.replace('{{version}}', version), 'utf8') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AbortSignalLike](./async-call-rpc.abortsignallike.md) > [aborted](./async-call-rpc.abortsignallike.aborted.md) | ||
|
||
## AbortSignalLike.aborted property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
readonly aborted: boolean; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AbortSignalLike](./async-call-rpc.abortsignallike.md) > [addEventListener](./async-call-rpc.abortsignallike.addeventlistener.md) | ||
|
||
## AbortSignalLike.addEventListener() method | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
addEventListener(type: 'abort', listener: () => void, options: { | ||
once: boolean; | ||
}): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| type | 'abort' | | | ||
| listener | () => void | | | ||
| options | { once: boolean; } | | | ||
|
||
**Returns:** | ||
|
||
void | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AbortSignalLike](./async-call-rpc.abortsignallike.md) | ||
|
||
## AbortSignalLike interface | ||
|
||
AbortSignal | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface AbortSignalLike | ||
``` | ||
|
||
## Remarks | ||
|
||
This is a subset of the AbortSignal interface defined in the \[WinterCG\](https://wintercg.org/). | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [aborted](./async-call-rpc.abortsignallike.aborted.md) | <code>readonly</code> | boolean | | | ||
| [reason](./async-call-rpc.abortsignallike.reason.md) | | any | | | ||
|
||
## Methods | ||
|
||
| Method | Description | | ||
| --- | --- | | ||
| [addEventListener(type, listener, options)](./async-call-rpc.abortsignallike.addeventlistener.md) | | | ||
| [removeEventListener(type, listener)](./async-call-rpc.abortsignallike.removeeventlistener.md) | | | ||
| [throwIfAborted()](./async-call-rpc.abortsignallike.throwifaborted.md) | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AbortSignalLike](./async-call-rpc.abortsignallike.md) > [reason](./async-call-rpc.abortsignallike.reason.md) | ||
|
||
## AbortSignalLike.reason property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
reason: any; | ||
``` |
23 changes: 23 additions & 0 deletions
23
docs/async-call-rpc.abortsignallike.removeeventlistener.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AbortSignalLike](./async-call-rpc.abortsignallike.md) > [removeEventListener](./async-call-rpc.abortsignallike.removeeventlistener.md) | ||
|
||
## AbortSignalLike.removeEventListener() method | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
removeEventListener(type: 'abort', listener: () => void): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| type | 'abort' | | | ||
| listener | () => void | | | ||
|
||
**Returns:** | ||
|
||
void | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AbortSignalLike](./async-call-rpc.abortsignallike.md) > [throwIfAborted](./async-call-rpc.abortsignallike.throwifaborted.md) | ||
|
||
## AbortSignalLike.throwIfAborted() method | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
throwIfAborted(): void; | ||
``` | ||
**Returns:** | ||
|
||
void | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AsyncCallOptions](./async-call-rpc.asynccalloptions.md) > [forceSignal](./async-call-rpc.asynccalloptions.forcesignal.md) | ||
|
||
## AsyncCallOptions.forceSignal property | ||
|
||
AbortSignal to force stop the instance. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
forceSignal?: AbortSignalLike; | ||
``` | ||
|
||
## Remarks | ||
|
||
`signal` is used to stop the instance. If the `signal` is aborted, then all new requests will be rejected, and the pending requests will be forcibly rejected and pending results will be ignored. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AsyncCallOptions](./async-call-rpc.asynccalloptions.md) > [signal](./async-call-rpc.asynccalloptions.signal.md) | ||
|
||
## AsyncCallOptions.signal property | ||
|
||
AbortSignal to stop the instance. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
signal?: AbortSignalLike; | ||
``` | ||
|
||
## Remarks | ||
|
||
`signal` is used to stop the instance. If the `signal` is aborted, then all new requests will be rejected, except for the pending ones. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
"name": "@jwk/json-rpc", | ||
"version": "{{version}}", | ||
"exports": { | ||
".": "./src/Async-Call.ts", | ||
"./full": "./src/index.ts" | ||
}, | ||
"include": ["src/**"], | ||
// https://github.com/jsr-io/jsr/issues/194 | ||
"exclude": [ | ||
"__tests__", | ||
"docs", | ||
"*.json", | ||
"src/*.json", | ||
"api", | ||
"examples", | ||
"utils-src", | ||
"vite.config.ts", | ||
"index.html", | ||
"*.yaml", | ||
"rollup.config.mjs", | ||
"utils", | ||
"next-docs" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.