Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add well-known symbols for ReadonlyMap and ReadonlySet #60142

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+382 −0
Open

Add well-known symbols for ReadonlyMap and ReadonlySet #60142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4a80a1
Add well-known symbols for ReadonlyMap and ReadonlySet
milkcask Oct 4, 2024
4bf9f75
Add baselines
milkcask Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/lib/es2015.symbol.wellknown.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,10 @@ interface Map<K, V> {
readonly [Symbol.toStringTag]: string;
}

interface ReadonlyMap<K, V> {
readonly [Symbol.toStringTag]: string;
}

interface WeakMap<K extends WeakKey, V> {
readonly [Symbol.toStringTag]: string;
}
Expand All @@ -127,6 +131,10 @@ interface Set<T> {
readonly [Symbol.toStringTag]: string;
}

interface ReadonlySet<T> {
readonly [Symbol.toStringTag]: string;
}

interface WeakSet<T extends WeakKey> {
readonly [Symbol.toStringTag]: string;
}
Expand Down
52 changes: 52 additions & 0 deletions tests/baselines/reference/symbolWellKnown.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
//// [tests/cases/conformance/es6/Symbols/symbolWellKnown.ts] ////

//// [symbolWellKnown.ts]
var symbol = Symbol();
symbol[Symbol.toStringTag];

var map = new Map();
map[Symbol.toStringTag];

var readonlyMap = <ReadonlyMap<unknown, unknown>>new Map();
readonlyMap[Symbol.toStringTag];

var weakMap = new WeakMap();
weakMap[Symbol.toStringTag];

var set = new Set();
set[Symbol.toStringTag];

var readonlySet = <ReadonlySet<any>>new Set();
readonlySet[Symbol.toStringTag];

var weakSet = new WeakSet();
weakSet[Symbol.toStringTag];

JSON[Symbol.toStringTag];

Math[Symbol.toStringTag];

var promise = new Promise(()=>{});
promise[Symbol.toStringTag];



//// [symbolWellKnown.js]
var symbol = Symbol();
symbol[Symbol.toStringTag];
var map = new Map();
map[Symbol.toStringTag];
var readonlyMap = new Map();
readonlyMap[Symbol.toStringTag];
var weakMap = new WeakMap();
weakMap[Symbol.toStringTag];
var set = new Set();
set[Symbol.toStringTag];
var readonlySet = new Set();
readonlySet[Symbol.toStringTag];
var weakSet = new WeakSet();
weakSet[Symbol.toStringTag];
JSON[Symbol.toStringTag];
Math[Symbol.toStringTag];
var promise = new Promise(() => { });
promise[Symbol.toStringTag];
98 changes: 98 additions & 0 deletions tests/baselines/reference/symbolWellKnown.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
//// [tests/cases/conformance/es6/Symbols/symbolWellKnown.ts] ////

=== symbolWellKnown.ts ===
var symbol = Symbol();
>symbol : Symbol(symbol, Decl(symbolWellKnown.ts, 0, 3))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

symbol[Symbol.toStringTag];
>symbol : Symbol(symbol, Decl(symbolWellKnown.ts, 0, 3))
>Symbol.toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

var map = new Map();
>map : Symbol(map, Decl(symbolWellKnown.ts, 3, 3))
>Map : Symbol(Map, Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

map[Symbol.toStringTag];
>map : Symbol(map, Decl(symbolWellKnown.ts, 3, 3))
>Symbol.toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

var readonlyMap = <ReadonlyMap<unknown, unknown>>new Map();
>readonlyMap : Symbol(readonlyMap, Decl(symbolWellKnown.ts, 6, 3))
>ReadonlyMap : Symbol(ReadonlyMap, Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Map : Symbol(Map, Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

readonlyMap[Symbol.toStringTag];
>readonlyMap : Symbol(readonlyMap, Decl(symbolWellKnown.ts, 6, 3))
>Symbol.toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

var weakMap = new WeakMap();
>weakMap : Symbol(weakMap, Decl(symbolWellKnown.ts, 9, 3))
>WeakMap : Symbol(WeakMap, Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

weakMap[Symbol.toStringTag];
>weakMap : Symbol(weakMap, Decl(symbolWellKnown.ts, 9, 3))
>Symbol.toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

var set = new Set();
>set : Symbol(set, Decl(symbolWellKnown.ts, 12, 3))
>Set : Symbol(Set, Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

set[Symbol.toStringTag];
>set : Symbol(set, Decl(symbolWellKnown.ts, 12, 3))
>Symbol.toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

var readonlySet = <ReadonlySet<any>>new Set();
>readonlySet : Symbol(readonlySet, Decl(symbolWellKnown.ts, 15, 3))
>ReadonlySet : Symbol(ReadonlySet, Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Set : Symbol(Set, Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

readonlySet[Symbol.toStringTag];
>readonlySet : Symbol(readonlySet, Decl(symbolWellKnown.ts, 15, 3))
>Symbol.toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

var weakSet = new WeakSet();
>weakSet : Symbol(weakSet, Decl(symbolWellKnown.ts, 18, 3))
>WeakSet : Symbol(WeakSet, Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.collection.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

weakSet[Symbol.toStringTag];
>weakSet : Symbol(weakSet, Decl(symbolWellKnown.ts, 18, 3))
>Symbol.toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

JSON[Symbol.toStringTag];
>JSON : Symbol(JSON, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol.toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

Math[Symbol.toStringTag];
>Math : Symbol(Math, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.core.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol.toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

var promise = new Promise(()=>{});
>promise : Symbol(promise, Decl(symbolWellKnown.ts, 25, 3))
>Promise : Symbol(Promise, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.promise.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))

promise[Symbol.toStringTag];
>promise : Symbol(promise, Decl(symbolWellKnown.ts, 25, 3))
>Symbol.toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>toStringTag : Symbol(SymbolConstructor.toStringTag, Decl(lib.es2015.symbol.wellknown.d.ts, --, --))


194 changes: 194 additions & 0 deletions tests/baselines/reference/symbolWellKnown.types
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
//// [tests/cases/conformance/es6/Symbols/symbolWellKnown.ts] ////

=== symbolWellKnown.ts ===
var symbol = Symbol();
>symbol : symbol
> : ^^^^^^
>Symbol() : symbol
> : ^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^

symbol[Symbol.toStringTag];
>symbol[Symbol.toStringTag] : string
> : ^^^^^^
>symbol : symbol
> : ^^^^^^
>Symbol.toStringTag : unique symbol
> : ^^^^^^^^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^
>toStringTag : unique symbol
> : ^^^^^^^^^^^^^

var map = new Map();
>map : Map<any, any>
> : ^^^^^^^^^^^^^
>new Map() : Map<any, any>
> : ^^^^^^^^^^^^^
>Map : MapConstructor
> : ^^^^^^^^^^^^^^

map[Symbol.toStringTag];
>map[Symbol.toStringTag] : string
> : ^^^^^^
>map : Map<any, any>
> : ^^^^^^^^^^^^^
>Symbol.toStringTag : unique symbol
> : ^^^^^^^^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^
>toStringTag : unique symbol
> : ^^^^^^^^^^^^^

var readonlyMap = <ReadonlyMap<unknown, unknown>>new Map();
>readonlyMap : ReadonlyMap<unknown, unknown>
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
><ReadonlyMap<unknown, unknown>>new Map() : ReadonlyMap<unknown, unknown>
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>new Map() : Map<any, any>
> : ^^^^^^^^^^^^^
>Map : MapConstructor
> : ^^^^^^^^^^^^^^

readonlyMap[Symbol.toStringTag];
>readonlyMap[Symbol.toStringTag] : string
> : ^^^^^^
>readonlyMap : ReadonlyMap<unknown, unknown>
> : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>Symbol.toStringTag : unique symbol
> : ^^^^^^^^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^
>toStringTag : unique symbol
> : ^^^^^^^^^^^^^

var weakMap = new WeakMap();
>weakMap : WeakMap<object, any>
> : ^^^^^^^^^^^^^^^^^^^^
>new WeakMap() : WeakMap<object, any>
> : ^^^^^^^^^^^^^^^^^^^^
>WeakMap : WeakMapConstructor
> : ^^^^^^^^^^^^^^^^^^

weakMap[Symbol.toStringTag];
>weakMap[Symbol.toStringTag] : string
> : ^^^^^^
>weakMap : WeakMap<object, any>
> : ^^^^^^^^^^^^^^^^^^^^
>Symbol.toStringTag : unique symbol
> : ^^^^^^^^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^
>toStringTag : unique symbol
> : ^^^^^^^^^^^^^

var set = new Set();
>set : Set<unknown>
> : ^^^^^^^^^^^^
>new Set() : Set<unknown>
> : ^^^^^^^^^^^^
>Set : SetConstructor
> : ^^^^^^^^^^^^^^

set[Symbol.toStringTag];
>set[Symbol.toStringTag] : string
> : ^^^^^^
>set : Set<unknown>
> : ^^^^^^^^^^^^
>Symbol.toStringTag : unique symbol
> : ^^^^^^^^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^
>toStringTag : unique symbol
> : ^^^^^^^^^^^^^

var readonlySet = <ReadonlySet<any>>new Set();
>readonlySet : ReadonlySet<any>
> : ^^^^^^^^^^^^^^^^
><ReadonlySet<any>>new Set() : ReadonlySet<any>
> : ^^^^^^^^^^^^^^^^
>new Set() : Set<any>
> : ^^^^^^^^
>Set : SetConstructor
> : ^^^^^^^^^^^^^^

readonlySet[Symbol.toStringTag];
>readonlySet[Symbol.toStringTag] : string
> : ^^^^^^
>readonlySet : ReadonlySet<any>
> : ^^^^^^^^^^^^^^^^
>Symbol.toStringTag : unique symbol
> : ^^^^^^^^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^
>toStringTag : unique symbol
> : ^^^^^^^^^^^^^

var weakSet = new WeakSet();
>weakSet : WeakSet<object>
> : ^^^^^^^^^^^^^^^
>new WeakSet() : WeakSet<object>
> : ^^^^^^^^^^^^^^^
>WeakSet : WeakSetConstructor
> : ^^^^^^^^^^^^^^^^^^

weakSet[Symbol.toStringTag];
>weakSet[Symbol.toStringTag] : string
> : ^^^^^^
>weakSet : WeakSet<object>
> : ^^^^^^^^^^^^^^^
>Symbol.toStringTag : unique symbol
> : ^^^^^^^^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^
>toStringTag : unique symbol
> : ^^^^^^^^^^^^^

JSON[Symbol.toStringTag];
>JSON[Symbol.toStringTag] : string
> : ^^^^^^
>JSON : JSON
> : ^^^^
>Symbol.toStringTag : unique symbol
> : ^^^^^^^^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^
>toStringTag : unique symbol
> : ^^^^^^^^^^^^^

Math[Symbol.toStringTag];
>Math[Symbol.toStringTag] : string
> : ^^^^^^
>Math : Math
> : ^^^^
>Symbol.toStringTag : unique symbol
> : ^^^^^^^^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^
>toStringTag : unique symbol
> : ^^^^^^^^^^^^^

var promise = new Promise(()=>{});
>promise : Promise<unknown>
> : ^^^^^^^^^^^^^^^^
>new Promise(()=>{}) : Promise<unknown>
> : ^^^^^^^^^^^^^^^^
>Promise : PromiseConstructor
> : ^^^^^^^^^^^^^^^^^^
>()=>{} : () => void
> : ^^^^^^^^^^

promise[Symbol.toStringTag];
>promise[Symbol.toStringTag] : string
> : ^^^^^^
>promise : Promise<unknown>
> : ^^^^^^^^^^^^^^^^
>Symbol.toStringTag : unique symbol
> : ^^^^^^^^^^^^^
>Symbol : SymbolConstructor
> : ^^^^^^^^^^^^^^^^^
>toStringTag : unique symbol
> : ^^^^^^^^^^^^^


30 changes: 30 additions & 0 deletions tests/cases/conformance/es6/Symbols/symbolWellKnown.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// @target: es2015

var symbol = Symbol();
symbol[Symbol.toStringTag];

var map = new Map();
map[Symbol.toStringTag];

var readonlyMap = <ReadonlyMap<unknown, unknown>>new Map();
readonlyMap[Symbol.toStringTag];

var weakMap = new WeakMap();
weakMap[Symbol.toStringTag];

var set = new Set();
set[Symbol.toStringTag];

var readonlySet = <ReadonlySet<any>>new Set();
readonlySet[Symbol.toStringTag];

var weakSet = new WeakSet();
weakSet[Symbol.toStringTag];

JSON[Symbol.toStringTag];

Math[Symbol.toStringTag];

var promise = new Promise(()=>{});
promise[Symbol.toStringTag];