Skip to content

Commit d1fe897

Browse files
committed
refactor: Tweak docs and some variable names
1 parent 7371b97 commit d1fe897

File tree

4 files changed

+13
-14
lines changed

4 files changed

+13
-14
lines changed

packages/json-rpc-engine/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ await server.handle(notification);
8181

8282
### Legacy compatibility
8383

84-
Use the `asLegacyMiddleware` function to use a `JsonRpcEngineV2` or V2 middleware as middleware in a legacy `JsonRpcEngine`.
84+
Use `asLegacyMiddleware()` to convert a `JsonRpcEngineV2` or one or more V2 middleware into a legacy middleware.
8585

8686
#### Context propagation
8787

packages/json-rpc-engine/src/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ engine.push(function (req, res, next, end) {
2323

2424
### V2 compatibility
2525

26-
Use the `asV2Middleware` function to use a `JsonRpcEngine` or legacy middleware as middleware in a
27-
`JsonRpcEngineV2`:
26+
Use `asV2Middleware()` to convert a `JsonRpcEngine` or one or more legacy middleware into a V2 middleware.
2827

2928
#### Context propagation
3029

packages/json-rpc-engine/src/asV2Middleware.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import {
88
} from '@metamask/utils';
99

1010
import type {
11+
JsonRpcEngine,
1112
JsonRpcEngineEndCallback,
1213
JsonRpcEngineNextCallback,
13-
JsonRpcEngine,
1414
} from './JsonRpcEngine';
1515
import { type JsonRpcMiddleware as LegacyMiddleware } from './JsonRpcEngine';
1616
import { mergeMiddleware } from './mergeMiddleware';
@@ -43,7 +43,7 @@ export function asV2Middleware<
4343
/**
4444
* Convert one or more legacy middleware into a {@link JsonRpcEngineV2} middleware.
4545
*
46-
* @param middleware - The legacy middleware(s) to convert.
46+
* @param middleware - The legacy middleware to convert.
4747
* @returns The {@link JsonRpcEngineV2} middleware.
4848
*/
4949
export function asV2Middleware<
@@ -54,10 +54,10 @@ export function asV2Middleware<
5454
): JsonRpcMiddleware<Request>;
5555

5656
/**
57-
* Implementation of asV2Middleware that handles all input types.
57+
* The asV2Middleware implementation.
5858
*
59-
* @param engineOrMiddleware - A legacy engine, a single legacy middleware, or an array of legacy middleware.
60-
* @param rest - Additional legacy middleware when the first argument is a single middleware.
59+
* @param engineOrMiddleware - A legacy engine or legacy middleware.
60+
* @param rest - Any additional legacy middleware when the first argument is a middleware.
6161
* @returns The {@link JsonRpcEngineV2} middleware.
6262
*/
6363
export function asV2Middleware<

packages/json-rpc-engine/src/v2/asLegacyMiddleware.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ export function asLegacyMiddleware<
3838
): LegacyMiddleware<Params, ResultConstraint<Request>>;
3939

4040
/**
41-
* Implementation of asLegacyMiddleware that handles all input types.
41+
* The asLegacyMiddleware implementation.
4242
*
43-
* @param engineOrMiddleware - A V2 engine, a single V2 middleware, or an array of V2 middleware.
44-
* @param rest - Additional V2 middleware when the first argument is a single middleware.
43+
* @param engineOrMiddleware - A V2 engine or V2 middleware.
44+
* @param rest - Any additional V2 middleware when the first argument is a middleware.
4545
* @returns The legacy middleware.
4646
*/
4747
export function asLegacyMiddleware<
@@ -53,7 +53,7 @@ export function asLegacyMiddleware<
5353
| JsonRpcMiddleware<Request, ResultConstraint<Request>>,
5454
...rest: JsonRpcMiddleware<Request, ResultConstraint<Request>>[]
5555
): LegacyMiddleware<Params, ResultConstraint<Request>> {
56-
const JsonRpcMiddleware =
56+
const v2Middleware =
5757
typeof engineOrMiddleware === 'function'
5858
? JsonRpcEngineV2.create({
5959
middleware: [engineOrMiddleware, ...rest],
@@ -65,11 +65,11 @@ export function asLegacyMiddleware<
6565
const context = makeContext(req);
6666
let modifiedRequest: Request | undefined;
6767

68-
const result = await JsonRpcMiddleware({
68+
const result = await v2Middleware({
6969
request,
7070
context,
7171
next: (finalRequest) => {
72-
modifiedRequest = finalRequest as Request | undefined;
72+
modifiedRequest = finalRequest;
7373
return Promise.resolve(undefined);
7474
},
7575
});

0 commit comments

Comments
 (0)