-
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.
refactor: rename AsyncCallStrictJSONRPC to AsyncCallStrictOptions
- Loading branch information
1 parent
0d0900b
commit 0431c15
Showing
9 changed files
with
93 additions
and
49 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": minor | ||
--- | ||
|
||
rename AsyncCallStrictJSONRPC to AsyncCallStrictOptions |
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,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AsyncCallStrictOptions](./async-call-rpc.asynccallstrictoptions.md) | ||
|
||
## AsyncCallStrictOptions interface | ||
|
||
Strict options | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface AsyncCallStrictOptions | ||
``` | ||
|
||
## Remarks | ||
|
||
Control the behavior that different from the JSON-RPC specification. | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [methodNotFound?](./async-call-rpc.asynccallstrictoptions.methodnotfound.md) | | boolean | _(Optional)_ Controls if AsyncCall send an ErrorResponse when the requested method is not defined. | | ||
| [unknownMessage?](./async-call-rpc.asynccallstrictoptions.unknownmessage.md) | | boolean | _(Optional)_ Controls if AsyncCall send an ErrorResponse when the message is not valid. | | ||
|
36 changes: 18 additions & 18 deletions
36
....asynccallstrictjsonrpc.methodnotfound.md → ....asynccallstrictoptions.methodnotfound.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 |
---|---|---|
@@ -1,18 +1,18 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AsyncCallStrictJSONRPC](./async-call-rpc.asynccallstrictjsonrpc.md) > [methodNotFound](./async-call-rpc.asynccallstrictjsonrpc.methodnotfound.md) | ||
|
||
## AsyncCallStrictJSONRPC.methodNotFound property | ||
|
||
Controls if AsyncCall send an ErrorResponse when the requested method is not defined. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
methodNotFound?: boolean; | ||
``` | ||
|
||
## Remarks | ||
|
||
If this option is set to false, AsyncCall will ignore the request and print a log if the method is not defined. | ||
|
||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AsyncCallStrictOptions](./async-call-rpc.asynccallstrictoptions.md) > [methodNotFound](./async-call-rpc.asynccallstrictoptions.methodnotfound.md) | ||
|
||
## AsyncCallStrictOptions.methodNotFound property | ||
|
||
Controls if AsyncCall send an ErrorResponse when the requested method is not defined. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
methodNotFound?: boolean; | ||
``` | ||
|
||
## Remarks | ||
|
||
If this option is set to false, AsyncCall will ignore the request and print a log if the method is not defined. | ||
|
36 changes: 18 additions & 18 deletions
36
....asynccallstrictjsonrpc.unknownmessage.md → ....asynccallstrictoptions.unknownmessage.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 |
---|---|---|
@@ -1,18 +1,18 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AsyncCallStrictJSONRPC](./async-call-rpc.asynccallstrictjsonrpc.md) > [unknownMessage](./async-call-rpc.asynccallstrictjsonrpc.unknownmessage.md) | ||
|
||
## AsyncCallStrictJSONRPC.unknownMessage property | ||
|
||
Controls if AsyncCall send an ErrorResponse when the message is not valid. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
unknownMessage?: boolean; | ||
``` | ||
|
||
## Remarks | ||
|
||
If this option is set to false, AsyncCall will ignore the request that cannot be parsed as a valid JSON RPC payload. This is useful when the message channel is also used to transfer other kinds of messages. | ||
|
||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [async-call-rpc](./async-call-rpc.md) > [AsyncCallStrictOptions](./async-call-rpc.asynccallstrictoptions.md) > [unknownMessage](./async-call-rpc.asynccallstrictoptions.unknownmessage.md) | ||
|
||
## AsyncCallStrictOptions.unknownMessage property | ||
|
||
Controls if AsyncCall send an ErrorResponse when the message is not valid. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
unknownMessage?: boolean; | ||
``` | ||
|
||
## Remarks | ||
|
||
If this option is set to false, AsyncCall will ignore the request that cannot be parsed as a valid JSON RPC payload. This is useful when the message channel is also used to transfer other kinds of messages. | ||
|
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