Skip to content

Commit 06841eb

Browse files
DanielRosenwasserDanielRosenwasser
committed
Merge pull request microsoft#4353 from Microsoft/updateES6DotDDotTsForFinalDraft
Update es6.d.ts for ES6 final draft (Part I)
2 parents 387da2f + bd9d2de commit 06841eb

68 files changed

Lines changed: 407 additions & 347 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/lib/core.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -324,9 +324,9 @@ interface String {
324324
/**
325325
* Replaces text in a string, using a regular expression or search string.
326326
* @param searchValue A String object or string literal that represents the regular expression
327-
* @param replaceValue A function that returns the replacement text.
327+
* @param replacer A function that returns the replacement text.
328328
*/
329-
replace(searchValue: string, replaceValue: (substring: string, ...args: any[]) => string): string;
329+
replace(searchValue: string, replacer: (substring: string, ...args: any[]) => string): string;
330330

331331
/**
332332
* Replaces text in a string, using a regular expression or search string.
@@ -338,9 +338,9 @@ interface String {
338338
/**
339339
* Replaces text in a string, using a regular expression or search string.
340340
* @param searchValue A Regular Expression object containing the regular expression pattern and applicable flags
341-
* @param replaceValue A function that returns the replacement text.
341+
* @param replacer A function that returns the replacement text.
342342
*/
343-
replace(searchValue: RegExp, replaceValue: (substring: string, ...args: any[]) => string): string;
343+
replace(searchValue: RegExp, replacer: (substring: string, ...args: any[]) => string): string;
344344

345345
/**
346346
* Finds the first substring match in a regular expression search.

‎src/lib/es6.d.ts‎

Lines changed: 87 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ interface SymbolConstructor {
8787
split: symbol;
8888

8989
/**
90-
* A method that converts an object to a corresponding primitive value.Called by the ToPrimitive
91-
* abstract operation.
90+
* A method that converts an object to a corresponding primitive value.
91+
* Called by the ToPrimitive abstract operation.
9292
*/
9393
toPrimitive: symbol;
9494

@@ -98,8 +98,8 @@ interface SymbolConstructor {
9898
*/
9999
toStringTag: symbol;
100100

101-
/**
102-
* An Object whose own property names are property names that are excluded from the with
101+
/**
102+
* An Object whose own property names are property names that are excluded from the 'with'
103103
* environment bindings of the associated objects.
104104
*/
105105
unscopables: symbol;
@@ -170,16 +170,19 @@ interface ObjectConstructor {
170170
}
171171

172172
interface Function {
173-
/**
174-
* Returns a new function object that is identical to the argument object in all ways except
175-
* for its identity and the value of its HomeObject internal slot.
176-
*/
177-
toMethod(newHome: Object): Function;
178-
179173
/**
180174
* Returns the name of the function. Function names are read-only and can not be changed.
181175
*/
182176
name: string;
177+
178+
/**
179+
* Determines whether the given value inherits from this function if this function was used
180+
* as a constructor function.
181+
*
182+
* A constructor function can control which objects are recognized as its instances by
183+
* 'instanceof' by overriding this method.
184+
*/
185+
[Symbol.hasInstance](value: any): boolean;
183186
}
184187

185188
interface NumberConstructor {
@@ -257,6 +260,20 @@ interface Array<T> {
257260
/** Iterator */
258261
[Symbol.iterator](): IterableIterator<T>;
259262

263+
/**
264+
* Returns an object whose properties have the value 'true'
265+
* when they will be absent when used in a 'with' statement.
266+
*/
267+
[Symbol.unscopables](): {
268+
copyWithin: boolean;
269+
entries: boolean;
270+
fill: boolean;
271+
find: boolean;
272+
findIndex: boolean;
273+
keys: boolean;
274+
values: boolean;
275+
};
276+
260277
/**
261278
* Returns an array of key, value pairs for every entry in the array
262279
*/
@@ -619,37 +636,76 @@ interface Math {
619636
[Symbol.toStringTag]: string;
620637
}
621638

639+
interface Date {
640+
/**
641+
* Converts a Date object to a string.
642+
*/
643+
[Symbol.toPrimitive](hint: "default"): string;
644+
/**
645+
* Converts a Date object to a string.
646+
*/
647+
[Symbol.toPrimitive](hint: "string"): string;
648+
/**
649+
* Converts a Date object to a number.
650+
*/
651+
[Symbol.toPrimitive](hint: "number"): number;
652+
/**
653+
* Converts a Date object to a string or number.
654+
*
655+
* @param hint The strings "number", "string", or "default" to specify what primitive to return.
656+
*
657+
* @throws {TypeError} If 'hint' was given something other than "number", "string", or "default".
658+
* @returns A number if 'hint' was "number", a string if 'hint' was "string" or "default".
659+
*/
660+
[Symbol.toPrimitive](hint: string): string | number;
661+
}
662+
622663
interface RegExp {
623-
/**
624-
* Matches a string with a regular expression, and returns an array containing the results of
664+
/**
665+
* Matches a string with this regular expression, and returns an array containing the results of
625666
* that search.
626667
* @param string A string to search within.
627668
*/
628-
match(string: string): string[];
669+
[Symbol.match](string: string): RegExpMatchArray;
629670

630671
/**
631-
* Replaces text in a string, using a regular expression.
632-
* @param searchValue A String object or string literal that represents the regular expression
672+
* Replaces text in a string, using this regular expression.
673+
* @param string A String object or string literal whose contents matching against
674+
* this regular expression will be replaced
633675
* @param replaceValue A String object or string literal containing the text to replace for every
634-
* successful match of rgExp in stringObj.
676+
* successful match of this regular expression.
635677
*/
636-
replace(string: string, replaceValue: string): string;
678+
[Symbol.replace](string: string, replaceValue: string): string;
637679

638-
search(string: string): number;
680+
/**
681+
* Replaces text in a string, using this regular expression.
682+
* @param string A String object or string literal whose contents matching against
683+
* this regular expression will be replaced
684+
* @param replacer A function that returns the replacement text.
685+
*/
686+
[Symbol.replace](string: string, replacer: (substring: string, ...args: any[]) => string): string;
639687

640688
/**
641-
* Returns an Array object into which substrings of the result of converting string to a String
642-
* have been stored. The substrings are determined by searching from left to right for matches
643-
* of the this value regular expression; these occurrences are not part of any substring in the
644-
* returned array, but serve to divide up the String value.
689+
* Finds the position beginning first substring match in a regular expression search
690+
* using this regular expression.
691+
*
692+
* @param string The string to search within.
693+
*/
694+
[Symbol.search](string: string): number;
695+
696+
/**
697+
* Returns an array of substrings that were delimited by strings in the original input that
698+
* match against this regular expression.
699+
*
700+
* If the regular expression contains capturing parentheses, then each time this
701+
* regular expression matches, the results (including any undefined results) of the
702+
* capturing parentheses are spliced.
645703
*
646-
* If the regular expression that contains capturing parentheses, then each time separator is
647-
* matched the results (including any undefined results) of the capturing parentheses are spliced.
648704
* @param string string value to split
649-
* @param limit if not undefined, the output array is truncated so that it contains no more
650-
* than limit elements.
705+
* @param limit if not undefined, the output array is truncated so that it contains no more
706+
* than 'limit' elements.
651707
*/
652-
split(string: string, limit?: number): string[];
708+
[Symbol.split](string: string, limit?: number): string[];
653709

654710
/**
655711
* Returns a string indicating the flags of the regular expression in question. This field is read-only.
@@ -678,6 +734,10 @@ interface RegExp {
678734
unicode: boolean;
679735
}
680736

737+
interface RegExpConstructor {
738+
[Symbol.species](): RegExpConstructor;
739+
}
740+
681741
interface Map<K, V> {
682742
clear(): void;
683743
delete(key: K): boolean;

‎tests/baselines/reference/arrayLiterals2ES6.symbols‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,14 @@ var temp2: [number[], string[]] = [[1, 2, 3], ["hello", "string"]];
7272

7373
interface myArray extends Array<Number> { }
7474
>myArray : Symbol(myArray, Decl(arrayLiterals2ES6.ts, 40, 67))
75-
>Array : Symbol(Array, Decl(lib.d.ts, 1000, 23), Decl(lib.d.ts, 1171, 11), Decl(lib.d.ts, 1452, 1))
75+
>Array : Symbol(Array, Decl(lib.d.ts, 1000, 23), Decl(lib.d.ts, 1171, 11), Decl(lib.d.ts, 1455, 1))
7676
>Number : Symbol(Number, Decl(lib.d.ts, 456, 40), Decl(lib.d.ts, 518, 11))
7777

7878
interface myArray2 extends Array<Number|String> { }
7979
>myArray2 : Symbol(myArray2, Decl(arrayLiterals2ES6.ts, 42, 43))
80-
>Array : Symbol(Array, Decl(lib.d.ts, 1000, 23), Decl(lib.d.ts, 1171, 11), Decl(lib.d.ts, 1452, 1))
80+
>Array : Symbol(Array, Decl(lib.d.ts, 1000, 23), Decl(lib.d.ts, 1171, 11), Decl(lib.d.ts, 1455, 1))
8181
>Number : Symbol(Number, Decl(lib.d.ts, 456, 40), Decl(lib.d.ts, 518, 11))
82-
>String : Symbol(String, Decl(lib.d.ts, 275, 1), Decl(lib.d.ts, 443, 11), Decl(lib.d.ts, 1556, 1))
82+
>String : Symbol(String, Decl(lib.d.ts, 275, 1), Decl(lib.d.ts, 443, 11), Decl(lib.d.ts, 1573, 1))
8383

8484
var d0 = [1, true, ...temp, ]; // has type (string|number|boolean)[]
8585
>d0 : Symbol(d0, Decl(arrayLiterals2ES6.ts, 44, 3))

‎tests/baselines/reference/asyncArrowFunction1_es6.symbols‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
var foo = async (): Promise<void> => {
44
>foo : Symbol(foo, Decl(asyncArrowFunction1_es6.ts, 1, 3))
5-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
5+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
66

77
};

‎tests/baselines/reference/asyncAwait_es6.symbols‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
type MyPromise<T> = Promise<T>;
33
>MyPromise : Symbol(MyPromise, Decl(asyncAwait_es6.ts, 0, 0), Decl(asyncAwait_es6.ts, 1, 11))
44
>T : Symbol(T, Decl(asyncAwait_es6.ts, 0, 15))
5-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
5+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
66
>T : Symbol(T, Decl(asyncAwait_es6.ts, 0, 15))
77

88
declare var MyPromise: typeof Promise;
99
>MyPromise : Symbol(MyPromise, Decl(asyncAwait_es6.ts, 0, 0), Decl(asyncAwait_es6.ts, 1, 11))
10-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
10+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
1111

1212
declare var p: Promise<number>;
1313
>p : Symbol(p, Decl(asyncAwait_es6.ts, 2, 11))
14-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
14+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
1515

1616
declare var mp: MyPromise<number>;
1717
>mp : Symbol(mp, Decl(asyncAwait_es6.ts, 3, 11))
@@ -22,7 +22,7 @@ async function f0() { }
2222

2323
async function f1(): Promise<void> { }
2424
>f1 : Symbol(f1, Decl(asyncAwait_es6.ts, 5, 23))
25-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
25+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
2626

2727
async function f3(): MyPromise<void> { }
2828
>f3 : Symbol(f3, Decl(asyncAwait_es6.ts, 6, 38))
@@ -33,7 +33,7 @@ let f4 = async function() { }
3333

3434
let f5 = async function(): Promise<void> { }
3535
>f5 : Symbol(f5, Decl(asyncAwait_es6.ts, 10, 3))
36-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
36+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
3737

3838
let f6 = async function(): MyPromise<void> { }
3939
>f6 : Symbol(f6, Decl(asyncAwait_es6.ts, 11, 3))
@@ -44,7 +44,7 @@ let f7 = async () => { };
4444

4545
let f8 = async (): Promise<void> => { };
4646
>f8 : Symbol(f8, Decl(asyncAwait_es6.ts, 14, 3))
47-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
47+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
4848

4949
let f9 = async (): MyPromise<void> => { };
5050
>f9 : Symbol(f9, Decl(asyncAwait_es6.ts, 15, 3))
@@ -60,7 +60,7 @@ let f11 = async () => mp;
6060

6161
let f12 = async (): Promise<number> => mp;
6262
>f12 : Symbol(f12, Decl(asyncAwait_es6.ts, 18, 3))
63-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
63+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
6464
>mp : Symbol(mp, Decl(asyncAwait_es6.ts, 3, 11))
6565

6666
let f13 = async (): MyPromise<number> => p;
@@ -76,7 +76,7 @@ let o = {
7676

7777
async m2(): Promise<void> { },
7878
>m2 : Symbol(m2, Decl(asyncAwait_es6.ts, 22, 16))
79-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
79+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
8080

8181
async m3(): MyPromise<void> { }
8282
>m3 : Symbol(m3, Decl(asyncAwait_es6.ts, 23, 31))
@@ -92,7 +92,7 @@ class C {
9292

9393
async m2(): Promise<void> { }
9494
>m2 : Symbol(m2, Decl(asyncAwait_es6.ts, 28, 15))
95-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
95+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
9696

9797
async m3(): MyPromise<void> { }
9898
>m3 : Symbol(m3, Decl(asyncAwait_es6.ts, 29, 30))
@@ -103,7 +103,7 @@ class C {
103103

104104
static async m5(): Promise<void> { }
105105
>m5 : Symbol(C.m5, Decl(asyncAwait_es6.ts, 31, 22))
106-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
106+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
107107

108108
static async m6(): MyPromise<void> { }
109109
>m6 : Symbol(C.m6, Decl(asyncAwait_es6.ts, 32, 37))

‎tests/baselines/reference/asyncFunctionDeclaration11_es6.symbols‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
=== tests/cases/conformance/async/es6/functionDeclarations/asyncFunctionDeclaration11_es6.ts ===
22
async function await(): Promise<void> {
33
>await : Symbol(await, Decl(asyncFunctionDeclaration11_es6.ts, 0, 0))
4-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
4+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
55
}

‎tests/baselines/reference/asyncFunctionDeclaration14_es6.symbols‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
=== tests/cases/conformance/async/es6/functionDeclarations/asyncFunctionDeclaration14_es6.ts ===
22
async function foo(): Promise<void> {
33
>foo : Symbol(foo, Decl(asyncFunctionDeclaration14_es6.ts, 0, 0))
4-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
4+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
55

66
return;
77
}

‎tests/baselines/reference/asyncFunctionDeclaration1_es6.symbols‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
=== tests/cases/conformance/async/es6/functionDeclarations/asyncFunctionDeclaration1_es6.ts ===
22
async function foo(): Promise<void> {
33
>foo : Symbol(foo, Decl(asyncFunctionDeclaration1_es6.ts, 0, 0))
4-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
4+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
55
}

‎tests/baselines/reference/awaitBinaryExpression1_es6.symbols‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ declare var a: boolean;
44

55
declare var p: Promise<boolean>;
66
>p : Symbol(p, Decl(awaitBinaryExpression1_es6.ts, 1, 11))
7-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
7+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
88

99
async function func(): Promise<void> {
1010
>func : Symbol(func, Decl(awaitBinaryExpression1_es6.ts, 1, 32))
11-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
11+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
1212

1313
"before";
1414
var b = await p || a;

‎tests/baselines/reference/awaitBinaryExpression2_es6.symbols‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ declare var a: boolean;
44

55
declare var p: Promise<boolean>;
66
>p : Symbol(p, Decl(awaitBinaryExpression2_es6.ts, 1, 11))
7-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
7+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
88

99
async function func(): Promise<void> {
1010
>func : Symbol(func, Decl(awaitBinaryExpression2_es6.ts, 1, 32))
11-
>Promise : Symbol(Promise, Decl(lib.d.ts, 4772, 1), Decl(lib.d.ts, 4858, 11))
11+
>Promise : Symbol(Promise, Decl(lib.d.ts, 4832, 1), Decl(lib.d.ts, 4918, 11))
1212

1313
"before";
1414
var b = await p && a;

0 commit comments

Comments
 (0)