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.

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

Index signatures contribute properties to unions #25307

Merged
merged 2 commits into from
Jul 6, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 17 additions & 2 deletions src/compiler/checker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5938,6 +5938,12 @@ namespace ts {
&& isTypeUsableAsLateBoundName(checkComputedPropertyName(node));
}

function isLateBoundName(name: __String): boolean {
return (name as string).charCodeAt(0) === CharacterCodes._ &&
(name as string).charCodeAt(1) === CharacterCodes._ &&
(name as string).charCodeAt(2) === CharacterCodes.at;
}

/**
* Indicates whether a declaration has a late-bindable dynamic name.
*/
Expand Down Expand Up @@ -7024,6 +7030,7 @@ namespace ts {

function createUnionOrIntersectionProperty(containingType: UnionOrIntersectionType, name: __String): Symbol | undefined {
let props: Symbol[] | undefined;
let indexTypes: Type[] | undefined;
const isUnion = containingType.flags & TypeFlags.Union;
const excludeModifiers = isUnion ? ModifierFlags.NonPublicAccessibilityModifier : 0;
// Flags we want to propagate to the result if they exist in all source symbols
Expand All @@ -7048,14 +7055,21 @@ namespace ts {
}
}
else if (isUnion) {
checkFlags |= CheckFlags.Partial;
const index = !isLateBoundName(name) && ((isNumericLiteralName(name) && getIndexInfoOfType(type, IndexKind.Number)) || getIndexInfoOfType(type, IndexKind.String));
if (index) {
checkFlags |= index.isReadonly ? CheckFlags.Readonly : 0;
indexTypes = append(indexTypes, index.type);
}
else {
checkFlags |= CheckFlags.Partial;
}
}
}
}
if (!props) {
return undefined;
}
if (props.length === 1 && !(checkFlags & CheckFlags.Partial)) {
if (props.length === 1 && !(checkFlags & CheckFlags.Partial) && !indexTypes) {
return props[0];
}
let declarations: Declaration[] | undefined;
Expand Down Expand Up @@ -7086,6 +7100,7 @@ namespace ts {
}
propTypes.push(type);
}
addRange(propTypes, indexTypes);
const result = createSymbol(SymbolFlags.Property | commonFlags, name, syntheticFlag | checkFlags);
result.containingType = containingType;
if (!hasNonUniformValueDeclaration && commonValueDeclaration) {
Expand Down
2 changes: 2 additions & 0 deletions tests/baselines/reference/typedefCrossModule2.symbols
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ var bb;

var bbb = new mod.Baz();
>bbb : Symbol(bbb, Decl(use.js, 5, 3))
>mod.Baz : Symbol(Baz)
>mod : Symbol(mod, Decl(use.js, 0, 3))
>Baz : Symbol(Baz)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mod is a union; one constituent has Baz: any and the other has a string index signature to any (as is commonly provided in JS). The union therefore now has a property Baz, although its type is still any.


=== tests/cases/conformance/jsdoc/mod1.js ===
// error
Expand Down
47 changes: 47 additions & 0 deletions tests/baselines/reference/unionTypeWithIndexSignature.errors.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
tests/cases/conformance/types/union/unionTypeWithIndexSignature.ts(11,3): error TS2339: Property 'bar' does not exist on type 'Missing'.
Property 'bar' does not exist on type '{ [s: string]: string; }'.
tests/cases/conformance/types/union/unionTypeWithIndexSignature.ts(14,4): error TS2540: Cannot assign to 'foo' because it is a constant or a read-only property.
tests/cases/conformance/types/union/unionTypeWithIndexSignature.ts(24,1): error TS7017: Element implicitly has an 'any' type because type 'Both' has no index signature.
tests/cases/conformance/types/union/unionTypeWithIndexSignature.ts(25,1): error TS2322: Type '"not ok"' is not assignable to type 'number'.
tests/cases/conformance/types/union/unionTypeWithIndexSignature.ts(26,1): error TS7017: Element implicitly has an 'any' type because type 'Both' has no index signature.


==== tests/cases/conformance/types/union/unionTypeWithIndexSignature.ts (5 errors) ====
type Two = { foo: { bar: true }, baz: true } | { [s: string]: string };
declare var u: Two
u.foo = 'bye'
u.baz = 'hi'
type Three = { foo: number } | { [s: string]: string } | { [s: string]: boolean };
declare var v: Three
v.foo = false
type Missing = { foo: number, bar: true } | { [s: string]: string } | { foo: boolean }
declare var m: Missing
m.foo = 'hi'
m.bar
~~~
!!! error TS2339: Property 'bar' does not exist on type 'Missing'.
!!! error TS2339: Property 'bar' does not exist on type '{ [s: string]: string; }'.
type RO = { foo: number } | { readonly [s: string]: string }
declare var ro: RO
ro.foo = 'not allowed'
~~~
!!! error TS2540: Cannot assign to 'foo' because it is a constant or a read-only property.
type Num = { '0': string } | { [n: number]: number }
declare var num: Num
num[0] = 1
num['0'] = 'ok'
const sym = Symbol()
type Both = { s: number, '0': number, [sym]: boolean } | { [n: number]: number, [s: string]: string | number }
declare var both: Both
both['s'] = 'ok'
both[0] = 1
both[1] = 0 // not ok
~~~~~~~
!!! error TS7017: Element implicitly has an 'any' type because type 'Both' has no index signature.
both[0] = 'not ok'
~~~~~~~
!!! error TS2322: Type '"not ok"' is not assignable to type 'number'.
both[sym] = 'not ok'
~~~~~~~~~
!!! error TS7017: Element implicitly has an 'any' type because type 'Both' has no index signature.

45 changes: 45 additions & 0 deletions tests/baselines/reference/unionTypeWithIndexSignature.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
//// [unionTypeWithIndexSignature.ts]
type Two = { foo: { bar: true }, baz: true } | { [s: string]: string };
declare var u: Two
u.foo = 'bye'
u.baz = 'hi'
type Three = { foo: number } | { [s: string]: string } | { [s: string]: boolean };
declare var v: Three
v.foo = false
type Missing = { foo: number, bar: true } | { [s: string]: string } | { foo: boolean }
declare var m: Missing
m.foo = 'hi'
m.bar
type RO = { foo: number } | { readonly [s: string]: string }
declare var ro: RO
ro.foo = 'not allowed'
type Num = { '0': string } | { [n: number]: number }
declare var num: Num
num[0] = 1
num['0'] = 'ok'
const sym = Symbol()
type Both = { s: number, '0': number, [sym]: boolean } | { [n: number]: number, [s: string]: string | number }
declare var both: Both
both['s'] = 'ok'
both[0] = 1
both[1] = 0 // not ok
both[0] = 'not ok'
both[sym] = 'not ok'


//// [unionTypeWithIndexSignature.js]
"use strict";
u.foo = 'bye';
u.baz = 'hi';
v.foo = false;
m.foo = 'hi';
m.bar;
ro.foo = 'not allowed';
num[0] = 1;
num['0'] = 'ok';
const sym = Symbol();
both['s'] = 'ok';
both[0] = 1;
both[1] = 0; // not ok
both[0] = 'not ok';
both[sym] = 'not ok';
123 changes: 123 additions & 0 deletions tests/baselines/reference/unionTypeWithIndexSignature.symbols
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
=== tests/cases/conformance/types/union/unionTypeWithIndexSignature.ts ===
type Two = { foo: { bar: true }, baz: true } | { [s: string]: string };
>Two : Symbol(Two, Decl(unionTypeWithIndexSignature.ts, 0, 0))
>foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 0, 12))
>bar : Symbol(bar, Decl(unionTypeWithIndexSignature.ts, 0, 19))
>baz : Symbol(baz, Decl(unionTypeWithIndexSignature.ts, 0, 32))
>s : Symbol(s, Decl(unionTypeWithIndexSignature.ts, 0, 50))

declare var u: Two
>u : Symbol(u, Decl(unionTypeWithIndexSignature.ts, 1, 11))
>Two : Symbol(Two, Decl(unionTypeWithIndexSignature.ts, 0, 0))

u.foo = 'bye'
>u.foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 0, 12))
>u : Symbol(u, Decl(unionTypeWithIndexSignature.ts, 1, 11))
>foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 0, 12))

u.baz = 'hi'
>u.baz : Symbol(baz, Decl(unionTypeWithIndexSignature.ts, 0, 32))
>u : Symbol(u, Decl(unionTypeWithIndexSignature.ts, 1, 11))
>baz : Symbol(baz, Decl(unionTypeWithIndexSignature.ts, 0, 32))

type Three = { foo: number } | { [s: string]: string } | { [s: string]: boolean };
>Three : Symbol(Three, Decl(unionTypeWithIndexSignature.ts, 3, 12))
>foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 4, 14))
>s : Symbol(s, Decl(unionTypeWithIndexSignature.ts, 4, 34))
>s : Symbol(s, Decl(unionTypeWithIndexSignature.ts, 4, 60))

declare var v: Three
>v : Symbol(v, Decl(unionTypeWithIndexSignature.ts, 5, 11))
>Three : Symbol(Three, Decl(unionTypeWithIndexSignature.ts, 3, 12))

v.foo = false
>v.foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 4, 14))
>v : Symbol(v, Decl(unionTypeWithIndexSignature.ts, 5, 11))
>foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 4, 14))

type Missing = { foo: number, bar: true } | { [s: string]: string } | { foo: boolean }
>Missing : Symbol(Missing, Decl(unionTypeWithIndexSignature.ts, 6, 13))
>foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 7, 16))
>bar : Symbol(bar, Decl(unionTypeWithIndexSignature.ts, 7, 29))
>s : Symbol(s, Decl(unionTypeWithIndexSignature.ts, 7, 47))
>foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 7, 71))

declare var m: Missing
>m : Symbol(m, Decl(unionTypeWithIndexSignature.ts, 8, 11))
>Missing : Symbol(Missing, Decl(unionTypeWithIndexSignature.ts, 6, 13))

m.foo = 'hi'
>m.foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 7, 16), Decl(unionTypeWithIndexSignature.ts, 7, 71))
>m : Symbol(m, Decl(unionTypeWithIndexSignature.ts, 8, 11))
>foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 7, 16), Decl(unionTypeWithIndexSignature.ts, 7, 71))

m.bar
>m : Symbol(m, Decl(unionTypeWithIndexSignature.ts, 8, 11))

type RO = { foo: number } | { readonly [s: string]: string }
>RO : Symbol(RO, Decl(unionTypeWithIndexSignature.ts, 10, 5))
>foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 11, 11))
>s : Symbol(s, Decl(unionTypeWithIndexSignature.ts, 11, 40))

declare var ro: RO
>ro : Symbol(ro, Decl(unionTypeWithIndexSignature.ts, 12, 11))
>RO : Symbol(RO, Decl(unionTypeWithIndexSignature.ts, 10, 5))

ro.foo = 'not allowed'
>ro.foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 11, 11))
>ro : Symbol(ro, Decl(unionTypeWithIndexSignature.ts, 12, 11))
>foo : Symbol(foo, Decl(unionTypeWithIndexSignature.ts, 11, 11))

type Num = { '0': string } | { [n: number]: number }
>Num : Symbol(Num, Decl(unionTypeWithIndexSignature.ts, 13, 22))
>'0' : Symbol('0', Decl(unionTypeWithIndexSignature.ts, 14, 12))
>n : Symbol(n, Decl(unionTypeWithIndexSignature.ts, 14, 32))

declare var num: Num
>num : Symbol(num, Decl(unionTypeWithIndexSignature.ts, 15, 11))
>Num : Symbol(Num, Decl(unionTypeWithIndexSignature.ts, 13, 22))

num[0] = 1
>num : Symbol(num, Decl(unionTypeWithIndexSignature.ts, 15, 11))
>0 : Symbol('0', Decl(unionTypeWithIndexSignature.ts, 14, 12))

num['0'] = 'ok'
>num : Symbol(num, Decl(unionTypeWithIndexSignature.ts, 15, 11))
>'0' : Symbol('0', Decl(unionTypeWithIndexSignature.ts, 14, 12))

const sym = Symbol()
>sym : Symbol(sym, Decl(unionTypeWithIndexSignature.ts, 18, 5))
>Symbol : Symbol(Symbol, Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.symbol.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --), Decl(lib.esnext.symbol.d.ts, --, --))

type Both = { s: number, '0': number, [sym]: boolean } | { [n: number]: number, [s: string]: string | number }
>Both : Symbol(Both, Decl(unionTypeWithIndexSignature.ts, 18, 20))
>s : Symbol(s, Decl(unionTypeWithIndexSignature.ts, 19, 13))
>'0' : Symbol('0', Decl(unionTypeWithIndexSignature.ts, 19, 24))
>[sym] : Symbol([sym], Decl(unionTypeWithIndexSignature.ts, 19, 37))
>sym : Symbol(sym, Decl(unionTypeWithIndexSignature.ts, 18, 5))
>n : Symbol(n, Decl(unionTypeWithIndexSignature.ts, 19, 60))
>s : Symbol(s, Decl(unionTypeWithIndexSignature.ts, 19, 81))

declare var both: Both
>both : Symbol(both, Decl(unionTypeWithIndexSignature.ts, 20, 11))
>Both : Symbol(Both, Decl(unionTypeWithIndexSignature.ts, 18, 20))

both['s'] = 'ok'
>both : Symbol(both, Decl(unionTypeWithIndexSignature.ts, 20, 11))
>'s' : Symbol(s, Decl(unionTypeWithIndexSignature.ts, 19, 13))

both[0] = 1
>both : Symbol(both, Decl(unionTypeWithIndexSignature.ts, 20, 11))
>0 : Symbol('0', Decl(unionTypeWithIndexSignature.ts, 19, 24))

both[1] = 0 // not ok
>both : Symbol(both, Decl(unionTypeWithIndexSignature.ts, 20, 11))

both[0] = 'not ok'
>both : Symbol(both, Decl(unionTypeWithIndexSignature.ts, 20, 11))
>0 : Symbol('0', Decl(unionTypeWithIndexSignature.ts, 19, 24))

both[sym] = 'not ok'
>both : Symbol(both, Decl(unionTypeWithIndexSignature.ts, 20, 11))
>sym : Symbol(sym, Decl(unionTypeWithIndexSignature.ts, 18, 5))

Loading