Skip to content

Make JSON-RPC error data property optional #31

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
merged 2 commits into from
Sep 28, 2022
Merged

Make JSON-RPC error data property optional #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1ac496
Make error data property optional
Mrtenz Sep 26, 2022
3b11f9e
Fix error type in JsonRpcFailure
Mrtenz Sep 28, 2022
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
19 changes: 17 additions & 2 deletions src/json.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,25 @@ export const JsonRpcErrorStruct = object({
stack: optional(string()),
});

/**
* Mark a certain key of a type as optional.
*/
export type OptionalField<
Type extends Record<string, unknown>,
Key extends keyof Type
> = Omit<Type, Key> & Partial<Pick<Type, Key>>;

/**
* A JSON-RPC error object.
*
* Note that TypeScript infers `unknown | undefined` as `unknown`, meaning that
* the `data` field is not optional. To make it optional, we use the
* `OptionalField` helper, to explicitly make it optional.
*/
export type JsonRpcError = Infer<typeof JsonRpcErrorStruct>;
export type JsonRpcError = OptionalField<
Infer<typeof JsonRpcErrorStruct>,
'data'
>;

export const JsonRpcParamsStruct = optional(union([object(), array()]));

Expand Down Expand Up @@ -224,7 +239,7 @@ export type JsonRpcSuccess<Result extends Json> = Omit<
export const JsonRpcFailureStruct = object({
id: JsonRpcIdStruct,
jsonrpc: JsonRpcVersionStruct,
error: JsonRpcErrorStruct,
error: JsonRpcErrorStruct as Struct<JsonRpcError>,
});

/**
Expand Down