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
|
=== tests/cases/conformance/jsdoc/validate.ts ===
// Validate in TS as simple validations would usually be interpreted as more special assignments
import x = require("./");
>x : typeof x
x.name;
>x.name : string
>x : typeof x
>name : string
x.middleInit;
>x.middleInit : string
>x : typeof x
>middleInit : string
x.lastName;
>x.lastName : string
>x : typeof x
>lastName : string
x.zip;
>x.zip : number
>x : typeof x
>zip : number
x.houseNumber;
>x.houseNumber : number
>x : typeof x
>houseNumber : number
x.zipStr;
>x.zipStr : string
>x : typeof x
>zipStr : string
x.name = "Another";
>x.name = "Another" : "Another"
>x.name : string
>x : typeof x
>name : string
>"Another" : "Another"
x.zip = 98123;
>x.zip = 98123 : 98123
>x.zip : number
>x : typeof x
>zip : number
>98123 : 98123
x.zipStr = "OK";
>x.zipStr = "OK" : "OK"
>x.zipStr : string
>x : typeof x
>zipStr : string
>"OK" : "OK"
x.lastName = "should fail";
>x.lastName = "should fail" : "should fail"
>x.lastName : any
>x : typeof x
>lastName : any
>"should fail" : "should fail"
x.houseNumber = 12; // should also fail
>x.houseNumber = 12 : 12
>x.houseNumber : any
>x : typeof x
>houseNumber : any
>12 : 12
x.zipStr = 12; // should fail
>x.zipStr = 12 : 12
>x.zipStr : string
>x : typeof x
>zipStr : string
>12 : 12
x.middleInit = "R"; // should also fail
>x.middleInit = "R" : "R"
>x.middleInit : any
>x : typeof x
>middleInit : any
>"R" : "R"
=== tests/cases/conformance/jsdoc/index.js ===
const x = {};
>x : typeof x
>{} : {}
Object.defineProperty(x, "name", { value: "Charles", writable: true });
>Object.defineProperty(x, "name", { value: "Charles", writable: true }) : any
>Object.defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>Object : ObjectConstructor
>defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>x : typeof x
>"name" : "name"
>{ value: "Charles", writable: true } : { value: string; writable: true; }
>value : string
>"Charles" : "Charles"
>writable : true
>true : true
Object.defineProperty(x, "middleInit", { value: "H" });
>Object.defineProperty(x, "middleInit", { value: "H" }) : any
>Object.defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>Object : ObjectConstructor
>defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>x : typeof x
>"middleInit" : "middleInit"
>{ value: "H" } : { value: string; }
>value : string
>"H" : "H"
Object.defineProperty(x, "lastName", { value: "Smith", writable: false });
>Object.defineProperty(x, "lastName", { value: "Smith", writable: false }) : any
>Object.defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>Object : ObjectConstructor
>defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>x : typeof x
>"lastName" : "lastName"
>{ value: "Smith", writable: false } : { value: string; writable: false; }
>value : string
>"Smith" : "Smith"
>writable : false
>false : false
Object.defineProperty(x, "zip", { get() { return 98122 }, set(_) { /*ignore*/ } });
>Object.defineProperty(x, "zip", { get() { return 98122 }, set(_) { /*ignore*/ } }) : any
>Object.defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>Object : ObjectConstructor
>defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>x : typeof x
>"zip" : "zip"
>{ get() { return 98122 }, set(_) { /*ignore*/ } } : { get(): number; set(_: any): void; }
>get : () => number
>98122 : 98122
>set : (_: any) => void
>_ : any
Object.defineProperty(x, "houseNumber", { get() { return 21.75 } });
>Object.defineProperty(x, "houseNumber", { get() { return 21.75 } }) : any
>Object.defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>Object : ObjectConstructor
>defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>x : typeof x
>"houseNumber" : "houseNumber"
>{ get() { return 21.75 } } : { get(): number; }
>get : () => number
>21.75 : 21.75
Object.defineProperty(x, "zipStr", {
>Object.defineProperty(x, "zipStr", { /** @param {string} str */ set(str) { this.zip = Number(str) }}) : any
>Object.defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>Object : ObjectConstructor
>defineProperty : (o: any, p: string | number | symbol, attributes: PropertyDescriptor & ThisType<any>) => any
>x : typeof x
>"zipStr" : "zipStr"
>{ /** @param {string} str */ set(str) { this.zip = Number(str) }} : { set(str: string): void; }
/** @param {string} str */
set(str) {
>set : (str: string) => void
>str : string
this.zip = Number(str)
>this.zip = Number(str) : number
>this.zip : any
>this : any
>zip : any
>Number(str) : number
>Number : NumberConstructor
>str : string
}
});
/**
* @param {{name: string}} named
*/
function takeName(named) { return named.name; }
>takeName : (named: { name: string; }) => string
>named : { name: string; }
>named.name : string
>named : { name: string; }
>name : string
takeName(x);
>takeName(x) : string
>takeName : (named: { name: string; }) => string
>x : typeof x
/**
* @type {number}
*/
var a = x.zip;
>a : number
>x.zip : number
>x : typeof x
>zip : number
/**
* @type {number}
*/
var b = x.houseNumber;
>b : number
>x.houseNumber : number
>x : typeof x
>houseNumber : number
const returnExemplar = () => x;
>returnExemplar : () => typeof x
>() => x : () => typeof x
>x : typeof x
const needsExemplar = (_ = x) => void 0;
>needsExemplar : (_?: typeof x) => undefined
>(_ = x) => void 0 : (_?: typeof x) => undefined
>_ : typeof x
>x : typeof x
>void 0 : undefined
>0 : 0
const expected = /** @type {{name: string, readonly middleInit: string, readonly lastName: string, zip: number, readonly houseNumber: number, zipStr: string}} */(/** @type {*} */(null));
>expected : { name: string; readonly middleInit: string; readonly lastName: string; zip: number; readonly houseNumber: number; zipStr: string; }
>(/** @type {*} */(null)) : { name: string; readonly middleInit: string; readonly lastName: string; zip: number; readonly houseNumber: number; zipStr: string; }
>(null) : any
>null : null
/**
*
* @param {typeof returnExemplar} a
* @param {typeof needsExemplar} b
*/
function match(a, b) {}
>match : (a: () => typeof x, b: (_?: typeof x) => undefined) => void
>a : () => typeof x
>b : (_?: typeof x) => undefined
match(() => expected, (x = expected) => void 0);
>match(() => expected, (x = expected) => void 0) : void
>match : (a: () => typeof x, b: (_?: typeof x) => undefined) => void
>() => expected : () => { name: string; readonly middleInit: string; readonly lastName: string; zip: number; readonly houseNumber: number; zipStr: string; }
>expected : { name: string; readonly middleInit: string; readonly lastName: string; zip: number; readonly houseNumber: number; zipStr: string; }
>(x = expected) => void 0 : (x?: typeof x | undefined) => undefined
>x : typeof x | undefined
>expected : { name: string; readonly middleInit: string; readonly lastName: string; zip: number; readonly houseNumber: number; zipStr: string; }
>void 0 : undefined
>0 : 0
module.exports = x;
>module.exports = x : typeof x
>module.exports : typeof x
>module : { "tests/cases/conformance/jsdoc/index": typeof x; }
>exports : typeof x
>x : typeof x
|
