/
typeguard.ts
412 lines (357 loc) · 10.5 KB
/
typeguard.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
/**
* @file Functions that typeguard the given node/type.
*/
import type { TSESTree } from "@typescript-eslint/experimental-utils";
import { AST_NODE_TYPES } from "@typescript-eslint/experimental-utils";
// TS import - only use this for types, will be stripped out by rollup.
import type { Type, UnionType } from "typescript";
// TS import - conditionally imported only when typescript is available.
import ts from "~/conditional-imports/typescript";
// Any JSDoc for these functions would be tedious.
// eslint-disable-next-line eslint-comments/disable-enable-pair
/* eslint-disable jsdoc/require-jsdoc */
/*
* TS Types.
*/
export type ArrayType = Type & {
readonly symbol: {
readonly name: "Array";
};
};
export type ArrayConstructorType = Type & {
readonly symbol: {
readonly name: "ArrayConstructor";
};
};
export type ObjectConstructorType = Type & {
readonly symbol: {
readonly name: "ObjectConstructor";
};
};
/*
* Node type guards.
*/
export function isArrayExpression(
node: TSESTree.Node
): node is TSESTree.ArrayExpression {
return node.type === AST_NODE_TYPES.ArrayExpression;
}
export function isAssignmentExpression(
node: TSESTree.Node
): node is TSESTree.AssignmentExpression {
return node.type === AST_NODE_TYPES.AssignmentExpression;
}
export function isAssignmentPattern(
node: TSESTree.Node
): node is TSESTree.AssignmentPattern {
return node.type === AST_NODE_TYPES.AssignmentPattern;
}
export function isBlockStatement(
node: TSESTree.Node
): node is TSESTree.BlockStatement {
return node.type === AST_NODE_TYPES.BlockStatement;
}
export function isCallExpression(
node: TSESTree.Node
): node is TSESTree.CallExpression {
return node.type === AST_NODE_TYPES.CallExpression;
}
export function isClassProperty(
node: TSESTree.Node
): node is TSESTree.ClassProperty {
return node.type === AST_NODE_TYPES.ClassProperty;
}
/**
* Is the given node a class node?
*
* It doesn't matter what type of class.
*/
export function isClassLike(
node: TSESTree.Node
): node is TSESTree.ClassDeclaration | TSESTree.ClassExpression {
return (
node.type === AST_NODE_TYPES.ClassDeclaration ||
node.type === AST_NODE_TYPES.ClassExpression
);
}
export function isExpressionStatement(
node: TSESTree.Node
): node is TSESTree.ExpressionStatement {
return node.type === AST_NODE_TYPES.ExpressionStatement;
}
export function isFunctionDeclaration(
node: TSESTree.Node
): node is TSESTree.FunctionDeclaration {
return node.type === AST_NODE_TYPES.FunctionDeclaration;
}
/**
* Is the given node a function expression node?
*
* It doesn't matter what type of function expression.
*/
export function isFunctionExpressionLike(
node: TSESTree.Node
): node is TSESTree.ArrowFunctionExpression | TSESTree.FunctionExpression {
return (
node.type === AST_NODE_TYPES.FunctionExpression ||
node.type === AST_NODE_TYPES.ArrowFunctionExpression
);
}
/**
* Is the given node a function node?
*
* It doesn't matter what type of function.
*/
export function isFunctionLike(
node: TSESTree.Node
): node is
| TSESTree.ArrowFunctionExpression
| TSESTree.FunctionDeclaration
| TSESTree.FunctionExpression {
return isFunctionDeclaration(node) || isFunctionExpressionLike(node);
}
export function isIdentifier(node: TSESTree.Node): node is TSESTree.Identifier {
return node.type === AST_NODE_TYPES.Identifier;
}
export function isIfStatement(
node: TSESTree.Node
): node is TSESTree.IfStatement {
return node.type === AST_NODE_TYPES.IfStatement;
}
export function isMemberExpression(
node: TSESTree.Node
): node is TSESTree.MemberExpression {
return node.type === AST_NODE_TYPES.MemberExpression;
}
export function isMethodDefinition(
node: TSESTree.Node
): node is TSESTree.MethodDefinition {
return node.type === AST_NODE_TYPES.MethodDefinition;
}
export function isNewExpression(
node: TSESTree.Node
): node is TSESTree.NewExpression {
return node.type === AST_NODE_TYPES.NewExpression;
}
export function isProperty(node: TSESTree.Node): node is TSESTree.Property {
return node.type === AST_NODE_TYPES.Property;
}
export function isRestElement(
node: TSESTree.Node
): node is TSESTree.RestElement {
return node.type === AST_NODE_TYPES.RestElement;
}
export function isReturnStatement(
node: TSESTree.Node
): node is TSESTree.ReturnStatement {
return node.type === AST_NODE_TYPES.ReturnStatement;
}
export function isThisExpression(
node: TSESTree.Node
): node is TSESTree.ThisExpression {
return node.type === AST_NODE_TYPES.ThisExpression;
}
export function isThrowStatement(
node: TSESTree.Node
): node is TSESTree.ThrowStatement {
return node.type === AST_NODE_TYPES.ThrowStatement;
}
export function isTSArrayType(
node: TSESTree.Node
): node is TSESTree.TSArrayType {
return node.type === AST_NODE_TYPES.TSArrayType;
}
export function isTSFunctionType(
node: TSESTree.Node
): node is TSESTree.TSFunctionType {
return node.type === AST_NODE_TYPES.TSFunctionType;
}
export function isTSIndexSignature(
node: TSESTree.Node
): node is TSESTree.TSIndexSignature {
return node.type === AST_NODE_TYPES.TSIndexSignature;
}
export function isTSInterfaceBody(
node: TSESTree.Node
): node is TSESTree.TSInterfaceBody {
return node.type === AST_NODE_TYPES.TSInterfaceBody;
}
export function isTSNullKeyword(
node: TSESTree.Node
): node is TSESTree.TSNullKeyword {
return node.type === AST_NODE_TYPES.TSNullKeyword;
}
export function isTSParameterProperty(
node: TSESTree.Node
): node is TSESTree.TSParameterProperty {
return node.type === AST_NODE_TYPES.TSParameterProperty;
}
export function isTSPropertySignature(
node: TSESTree.Node
): node is TSESTree.TSPropertySignature {
return node.type === AST_NODE_TYPES.TSPropertySignature;
}
export function isTSTupleType(
node: TSESTree.Node
): node is TSESTree.TSTupleType {
return node.type === AST_NODE_TYPES.TSTupleType;
}
export function isTSTypeAliasDeclaration(
node: TSESTree.Node
): node is TSESTree.TSTypeAliasDeclaration {
return node.type === AST_NODE_TYPES.TSTypeAliasDeclaration;
}
export function isTSTypeAnnotation(
node: TSESTree.Node
): node is TSESTree.TSTypeAnnotation {
return node.type === AST_NODE_TYPES.TSTypeAnnotation;
}
export function isTSTypeLiteral(
node: TSESTree.Node
): node is TSESTree.TSTypeLiteral {
return node.type === AST_NODE_TYPES.TSTypeLiteral;
}
export function isTSTypeOperator(
node: TSESTree.Node
): node is TSESTree.TSTypeOperator {
return node.type === AST_NODE_TYPES.TSTypeOperator;
}
export function isTSTypeReference(
node: TSESTree.Node
): node is TSESTree.TSTypeReference {
return node.type === AST_NODE_TYPES.TSTypeReference;
}
export function isTSUndefinedKeyword(
node: TSESTree.Node
): node is TSESTree.TSUndefinedKeyword {
return node.type === AST_NODE_TYPES.TSUndefinedKeyword;
}
export function isTSVoidKeyword(
node: TSESTree.Node
): node is TSESTree.TSVoidKeyword {
return node.type === AST_NODE_TYPES.TSVoidKeyword;
}
export function isUnaryExpression(
node: TSESTree.Node
): node is TSESTree.UnaryExpression {
return node.type === AST_NODE_TYPES.UnaryExpression;
}
export function isVariableDeclaration(
node: TSESTree.Node
): node is TSESTree.VariableDeclaration {
return node.type === AST_NODE_TYPES.VariableDeclaration;
}
export function isVariableDeclarator(
node: TSESTree.Node
): node is TSESTree.VariableDeclarator {
return node.type === AST_NODE_TYPES.VariableDeclarator;
}
export function hasID(
node: TSESTree.Node
): node is TSESTree.Node & { readonly id: unknown } {
return Object.prototype.hasOwnProperty.call(node, "id");
}
export function hasKey(
node: TSESTree.Node
): node is TSESTree.Node & { readonly key: unknown } {
return Object.prototype.hasOwnProperty.call(node, "key");
}
/*
* TS types type guards.
*/
export function isUnionType(type: Type): type is UnionType {
return ts !== undefined && type.flags === ts.TypeFlags.Union;
}
export function isArrayType(type: Type | null): type is ArrayType;
export function isArrayType(
type: Type,
assumeType: false,
node: null
): type is ArrayType;
export function isArrayType(
type: Type | null,
assumeType: boolean,
node: TSESTree.Node | null
): type is ArrayType;
export function isArrayType(
type: null,
assumeType: true,
node: TSESTree.Node
): boolean;
export function isArrayType(
type: Type | null,
assumeType = false,
node: TSESTree.Node | null = null
): boolean {
return assumeType === true && type === null
? node !== null
: type !== null &&
((type.symbol !== undefined && type.symbol.name === "Array") ||
(isUnionType(type) &&
type.types.some((t) => isArrayType(t, false, null))));
}
export function isArrayConstructorType(
type: Type | null
): type is ArrayConstructorType;
export function isArrayConstructorType(
type: Type,
assumeType: false,
node: null
): type is ArrayConstructorType;
export function isArrayConstructorType(
type: Type | null,
assumeType: boolean,
node: TSESTree.Node | null
): type is ArrayConstructorType;
export function isArrayConstructorType(
type: null,
assumeType: true,
node: TSESTree.Node
): boolean;
export function isArrayConstructorType(
type: Type | null,
assumeType = false,
node: TSESTree.Node | null = null
): boolean {
return assumeType === true && type === null
? node !== null && isIdentifier(node) && node.name === "Array"
: type !== null &&
((type.symbol !== undefined &&
type.symbol.name === "ArrayConstructor") ||
(isUnionType(type) &&
type.types.some((t) => isArrayConstructorType(t, false, null))));
}
export function isObjectConstructorType(
type: Type | null
): type is ObjectConstructorType;
export function isObjectConstructorType(
type: Type,
assumeType: false,
node: null
): type is ObjectConstructorType;
export function isObjectConstructorType(
type: Type | null,
assumeType: boolean,
node: TSESTree.Node | null
): type is ObjectConstructorType;
export function isObjectConstructorType(
type: null,
assumeType: true,
node: TSESTree.Node
): boolean;
export function isObjectConstructorType(
type: Type | null,
assumeType = false,
node: TSESTree.Node | null = null
): boolean {
return assumeType === true && type === null
? node !== null && isIdentifier(node) && node.name === "Object"
: type !== null &&
((type.symbol !== undefined &&
type.symbol.name === "ObjectConstructor") ||
(isUnionType(type) &&
type.types.some((t) => isObjectConstructorType(t, false, null))));
}
export function isNeverType(type: Type): boolean {
return ts !== undefined && type.flags === ts.TypeFlags.Never;
}