Skip to content

Commit 2c89110

Browse files
Give function type parameters descriptive names (#2173) (#59880)
Co-authored-by: Vitali Zaidman <vzaidman@meta.com>
1 parent f480836 commit 2c89110

4 files changed

Lines changed: 49 additions & 40 deletions

File tree

‎flow-typed/environment/node.js‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2549,7 +2549,7 @@ declare module 'fs' {
25492549
...
25502550
}>,
25512551
writeFile(
2552-
v0: FSPromisePath | FileHandle,
2552+
file: FSPromisePath | FileHandle,
25532553
data: string | Buffer | Uint8Array,
25542554
options?: string | WriteOptions,
25552555
): Promise<void>,
@@ -3343,9 +3343,9 @@ declare module 'perf_hooks' {
33433343
setResourceTimingBufferSize(maxSize: number): void;
33443344
readonly timeOrigin: number;
33453345
timerify<TArgs extends Iterable<unknown>, TReturn>(
3346-
fn: (...rest: TArgs) => TReturn,
3346+
fn: (...args: TArgs) => TReturn,
33473347
options?: Readonly<{histogram?: RecordableHistogram}>,
3348-
): (...rest: TArgs) => TReturn;
3348+
): (...args: TArgs) => TReturn;
33493349
toJSON(): unknown;
33503350
}
33513351

@@ -3537,7 +3537,7 @@ type readline$InterfaceCompleter = (
35373537
| [Array<string>, string]
35383538
| ((
35393539
line: string,
3540-
v1: (err: ?Error, data: [Array<string>, string]) => void,
3540+
callback: (err: ?Error, data: [Array<string>, string]) => void,
35413541
) => void);
35423542

35433543
declare class readline$Interface extends events$EventEmitter {
@@ -5630,18 +5630,18 @@ declare class Process extends events$EventEmitter {
56305630
emitWarning(warning: string | Error): void;
56315631
emitWarning(
56325632
warning: string,
5633-
typeOrCtor: string | ((...rest: empty) => unknown),
5633+
typeOrCtor: string | ((...args: empty) => unknown),
56345634
): void;
56355635
emitWarning(
56365636
warning: string,
56375637
type: string,
5638-
codeOrCtor: string | ((...rest: empty) => unknown),
5638+
codeOrCtor: string | ((...args: empty) => unknown),
56395639
): void;
56405640
emitWarning(
56415641
warning: string,
56425642
type: string,
56435643
code: string,
5644-
ctor?: (...rest: empty) => unknown,
5644+
ctor?: (...args: empty) => unknown,
56455645
): void;
56465646
execArgv: Array<string>;
56475647
execPath: string;
@@ -5671,7 +5671,7 @@ declare class Process extends events$EventEmitter {
56715671
},
56725672
rss: () => number,
56735673
};
5674-
nextTick: <T>(cb: (...rest: T) => unknown, ...rest: T) => void;
5674+
nextTick: <T>(cb: (...args: T) => unknown, ...args: T) => void;
56755675
pid: number;
56765676
platform: string;
56775677
release: {

‎flow-typed/npm/babel-traverse_v7.x.x.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -631,7 +631,7 @@ declare module '@babel/traverse' {
631631

632632
constructor(hub: HubInterface, parent: BabelNode): NodePath<TNode>;
633633

634-
static get(v: {
634+
static get(options: {
635635
hub: HubInterface,
636636
parentPath: ?NodePath<>,
637637
parent: BabelNode,

‎flow-typed/npm/babel_v7.x.x.js‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ declare module '@babel/core' {
387387
buildCodeFrameError<TError extends Error>(
388388
node: BabelNode,
389389
msg: string,
390-
v2: Class<TError>,
390+
Error: Class<TError>,
391391
): TError;
392392

393393
mergeSourceMap(map: _BabelSourceMap): _BabelSourceMap;
@@ -408,7 +408,7 @@ declare module '@babel/core' {
408408

409409
parseShebang(): void;
410410

411-
makeResult<T>(v: TransformResult<T>): TransformResult<T>;
411+
makeResult<T>(result: TransformResult<T>): TransformResult<T>;
412412

413413
generate(): TransformResult<>;
414414
}
@@ -955,8 +955,8 @@ declare module '@babel/core' {
955955
|};
956956

957957
declare type TransformCallback<TMetadata> =
958-
| ((v0: Error, v1: null) => unknown)
959-
| ((v0: null, v1: TransformResult<TMetadata> | null) => unknown);
958+
| ((error: Error, result: null) => unknown)
959+
| ((error: null, result: TransformResult<TMetadata> | null) => unknown);
960960

961961
/**
962962
* Transforms the passed in code. Calling a callback with an object with the generated code, source map, and AST.
@@ -1043,7 +1043,7 @@ declare module '@babel/core' {
10431043
code: string,
10441044
options?: BabelCoreOptions,
10451045
callback:
1046-
((error: Error) => void) | ((v0: void, v1: BabelNodeFile) => void),
1046+
((error: Error) => void) | ((error: void, ast: BabelNodeFile) => void),
10471047
): void;
10481048

10491049
declare export function parseSync(
@@ -1097,8 +1097,8 @@ declare module '@babel/core' {
10971097
declare export function loadOptions(
10981098
options?: unknown,
10991099
callback:
1100-
| ((error: Error, v1: null) => unknown)
1101-
| ((v0: null, config: ResolvedConfig | null) => unknown),
1100+
| ((error: Error, config: null) => unknown)
1101+
| ((error: null, config: ResolvedConfig | null) => unknown),
11021102
): void;
11031103
declare export function loadOptionsSync(
11041104
options?: unknown,
@@ -1126,8 +1126,8 @@ declare module '@babel/core' {
11261126
declare export function loadPartialConfig(
11271127
options?: unknown,
11281128
callback:
1129-
| ((error: Error, v1: null) => unknown)
1130-
| ((v0: null, config: PartialConfig | null) => unknown),
1129+
| ((error: Error, config: null) => unknown)
1130+
| ((error: null, config: PartialConfig | null) => unknown),
11311131
): void;
11321132
declare export function loadPartialConfigSync(
11331133
options?: unknown,
@@ -1315,13 +1315,13 @@ declare module '@babel/template' {
13151315
(opts: PublicOpts): TemplateBuilder<T>,
13161316

13171317
// Building from a string produces an AST builder function by default.
1318-
(tpl: string, opts: ?PublicOpts): (v: ?PublicReplacements) => T,
1318+
(tpl: string, opts: ?PublicOpts): (replacements: ?PublicReplacements) => T,
13191319

13201320
// Building from a template literal produces an AST builder function by default.
13211321
(
13221322
tpl: Array<string>,
13231323
...args: Array<unknown>
1324-
): (v: ?PublicReplacements) => T,
1324+
): (replacements: ?PublicReplacements) => T,
13251325

13261326
// Allow users to explicitly create templates that produce ASTs, skipping
13271327
// the need for an intermediate function.
@@ -1354,13 +1354,13 @@ declare module '@babel/template' {
13541354
(
13551355
tpl: string,
13561356
opts: ?PublicOpts,
1357-
): (v: ?PublicReplacements) => Statement | Array<Statement>,
1357+
): (replacements: ?PublicReplacements) => Statement | Array<Statement>,
13581358

13591359
// Building from a template literal produces an AST builder function by default.
13601360
(
13611361
tpl: Array<string>,
13621362
...args: Array<unknown>
1363-
): (v: ?PublicReplacements) => Statement | Array<Statement>,
1363+
): (replacements: ?PublicReplacements) => Statement | Array<Statement>,
13641364

13651365
// Allow users to explicitly create templates that produce ASTs, skipping
13661366
// the need for an intermediate function.

‎flow-typed/npm/ws_v7.x.x.js‎

Lines changed: 27 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -47,34 +47,40 @@ declare class ws$WebSocketServer extends events$EventEmitter {
4747
/**
4848
* Emitted when the server closes.
4949
*/
50-
on(event: 'close', v1: () => unknown): this;
50+
on(event: 'close', listener: () => unknown): this;
5151

5252
/**
5353
* Emitted when the handshake is complete.
5454
*/
5555
on(
5656
event: 'connection',
57-
v1: (socket: ws$WebSocket, request: http$IncomingMessage<>) => unknown,
57+
listener: (
58+
socket: ws$WebSocket,
59+
request: http$IncomingMessage<>,
60+
) => unknown,
5861
): this;
5962

6063
/**
6164
* Emitted when an error occurs on the underlying server.
6265
*/
63-
on(event: 'error', v1: (error: Error) => unknown): this;
66+
on(event: 'error', listener: (error: Error) => unknown): this;
6467

6568
/**
6669
* Emitted before the response headers are written to the socket as part of
6770
* the handshake.
6871
*/
6972
on(
7073
event: 'headers',
71-
v1: (headers: Array<string>, request: http$IncomingMessage<>) => unknown,
74+
listener: (
75+
headers: Array<string>,
76+
request: http$IncomingMessage<>,
77+
) => unknown,
7278
): this;
7379

7480
/**
7581
* Emitted when the underlying server has been bound.
7682
*/
77-
on(event: 'listening', v1: () => unknown): this;
83+
on(event: 'listening', listener: () => unknown): this;
7884

7985
/**
8086
* Returns the bound address, the address family name, and port of the server
@@ -102,7 +108,7 @@ declare class ws$WebSocketServer extends events$EventEmitter {
102108
request: http$IncomingMessage<>,
103109
socket: net$Socket,
104110
head: Buffer,
105-
callback: (v: ?ws$WebSocket) => unknown,
111+
callback: (socket: ?ws$WebSocket) => unknown,
106112
): void;
107113

108114
/**
@@ -137,8 +143,8 @@ declare type ws$MessageListener = (
137143
isBinary: boolean,
138144
) => unknown;
139145
declare type ws$OpenListener = () => unknown;
140-
declare type ws$PingListener = (v: Buffer) => unknown;
141-
declare type ws$PongListener = (v: Buffer) => unknown;
146+
declare type ws$PingListener = (data: Buffer) => unknown;
147+
declare type ws$PongListener = (data: Buffer) => unknown;
142148
declare type ws$UnexpectedResponseListener = (
143149
request: http$ClientRequest<>,
144150
response: http$IncomingMessage<>,
@@ -173,44 +179,47 @@ declare class ws$WebSocket extends events$EventEmitter {
173179
/*
174180
* Emitted when the connection is closed.
175181
*/
176-
on(v0: 'close', v1: ws$CloseListener): this;
182+
on(event: 'close', listener: ws$CloseListener): this;
177183

178184
/*
179185
* Emitted when an error occurs.
180186
*/
181-
on(v0: 'error', v1: ws$ErrorListener): this;
187+
on(event: 'error', listener: ws$ErrorListener): this;
182188

183189
/*
184190
* Emitted when a message is received from the server.
185191
*/
186-
on(v0: 'message', v1: ws$MessageListener): this;
192+
on(event: 'message', listener: ws$MessageListener): this;
187193

188194
/*
189195
* Emitted when the connection is established.
190196
*/
191-
on(v0: 'open', v1: ws$OpenListener): this;
197+
on(event: 'open', listener: ws$OpenListener): this;
192198

193199
/*
194200
* Emitted when a ping is received from the server.
195201
*/
196-
on(v0: 'ping', v1: ws$PingListener): this;
202+
on(event: 'ping', listener: ws$PingListener): this;
197203

198204
/*
199205
* Emitted when a pong is received from the server.
200206
*/
201-
on(v0: 'pong', v1: ws$PongListener): this;
207+
on(event: 'pong', listener: ws$PongListener): this;
202208

203209
/*
204210
* Emitted when the server response is not the expected one,
205211
* for example a 401 response.
206212
*/
207-
on(v0: 'unexpected-response', v1: ws$UnexpectedResponseListener): this;
213+
on(
214+
event: 'unexpected-response',
215+
listener: ws$UnexpectedResponseListener,
216+
): this;
208217

209218
/*
210219
* Emitted when response headers are received from the server as part of the
211220
* handshake.
212221
*/
213-
on(v0: 'upgrade', v1: ws$UpgradeListener): this;
222+
on(event: 'upgrade', listener: ws$UpgradeListener): this;
214223

215224
/**
216225
* Register an event listener emulating the `EventTarget` interface.
@@ -247,7 +256,7 @@ declare class ws$WebSocket extends events$EventEmitter {
247256
): this;
248257
addEventListener(
249258
type: 'unexpected-response',
250-
v1: ws$UnexpectedResponseListener,
259+
listener: ws$UnexpectedResponseListener,
251260
options?: {once?: boolean},
252261
): this;
253262
addEventListener(
@@ -313,7 +322,7 @@ declare class ws$WebSocket extends events$EventEmitter {
313322
removeEventListener(type: 'pong', listener: ws$PongListener): this;
314323
removeEventListener(
315324
type: 'unexpected-response',
316-
v1: ws$UnexpectedResponseListener,
325+
listener: ws$UnexpectedResponseListener,
317326
): this;
318327
removeEventListener(type: 'upgrade', listener: ws$UpgradeListener): this;
319328

0 commit comments

Comments
 (0)