Skip to content

refactor: Add Json default parameter to JSON-RPC types #241

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
rekmarks merged 1 commit into from
Mar 13, 2025
Merged

refactor: Add Json default parameter to JSON-RPC types #241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 9 additions & 11 deletions src/json.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@ export const PendingJsonRpcResponseStruct = superstructObject({
/**
* A JSON-RPC response object that has not yet been resolved.
*/
export type PendingJsonRpcResponse<Result extends Json> = Omit<
export type PendingJsonRpcResponse<Result extends Json = Json> = Omit<
Infer<typeof PendingJsonRpcResponseStruct>,
'result'
> & {
Expand All @@ -453,7 +453,7 @@ export const JsonRpcSuccessStruct = object({
/**
* A successful JSON-RPC response object.
*/
export type JsonRpcSuccess<Result extends Json> = Omit<
export type JsonRpcSuccess<Result extends Json = Json> = Omit<
Infer<typeof JsonRpcSuccessStruct>,
'result'
> & {
Expand Down Expand Up @@ -482,7 +482,7 @@ export const JsonRpcResponseStruct = union([
*
* @template Result - The type of the result.
*/
export type JsonRpcResponse<Result extends Json> =
export type JsonRpcResponse<Result extends Json = Json> =
| JsonRpcSuccess<Result>
| JsonRpcFailure;

Expand All @@ -495,7 +495,7 @@ export type JsonRpcResponse<Result extends Json> =
*/
export function isPendingJsonRpcResponse(
response: unknown,
): response is PendingJsonRpcResponse<Json> {
): response is PendingJsonRpcResponse {
return is(response, PendingJsonRpcResponseStruct);
}

Expand All @@ -512,7 +512,7 @@ export function assertIsPendingJsonRpcResponse(
response: unknown,
// eslint-disable-next-line @typescript-eslint/naming-convention
ErrorWrapper?: AssertionErrorConstructor,
): asserts response is PendingJsonRpcResponse<Json> {
): asserts response is PendingJsonRpcResponse {
assertStruct(
response,
PendingJsonRpcResponseStruct,
Expand All @@ -529,7 +529,7 @@ export function assertIsPendingJsonRpcResponse(
*/
export function isJsonRpcResponse(
response: unknown,
): response is JsonRpcResponse<Json> {
): response is JsonRpcResponse {
return is(response, JsonRpcResponseStruct);
}

Expand All @@ -545,7 +545,7 @@ export function assertIsJsonRpcResponse(
value: unknown,
// eslint-disable-next-line @typescript-eslint/naming-convention
ErrorWrapper?: AssertionErrorConstructor,
): asserts value is JsonRpcResponse<Json> {
): asserts value is JsonRpcResponse {
assertStruct(
value,
JsonRpcResponseStruct,
Expand All @@ -560,9 +560,7 @@ export function assertIsJsonRpcResponse(
* @param value - The value to check.
* @returns Whether the given value is a valid {@link JsonRpcSuccess} object.
*/
export function isJsonRpcSuccess(
value: unknown,
): value is JsonRpcSuccess<Json> {
export function isJsonRpcSuccess(value: unknown): value is JsonRpcSuccess {
return is(value, JsonRpcSuccessStruct);
}

Expand All @@ -578,7 +576,7 @@ export function assertIsJsonRpcSuccess(
value: unknown,
// eslint-disable-next-line @typescript-eslint/naming-convention
ErrorWrapper?: AssertionErrorConstructor,
): asserts value is JsonRpcSuccess<Json> {
): asserts value is JsonRpcSuccess {
assertStruct(
value,
JsonRpcSuccessStruct,
Expand Down
Loading