microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-02-04 21:53:42 -06:00
Code Issues Packages Projects Releases 212 Wiki Activity

Merge pull request #26431 from mattmccutchen/issue-26430

Browse Source 
Mapped types like Pick<T, K> should adopt property documentation from T.
This commit is contained in:
Ryan Cavanaugh 2018-08-16 13:35:55 -07:00 committed by GitHub
commit 7a658256a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/compiler/checker.ts
View File

@ -6649,7 +6649,7 @@ namespace ts {
if (isMappedTypeWithKeyofConstraintDeclaration(type)) {
// We have a { [P in keyof T]: X }
for (const prop of getPropertiesOfType(modifiersType)) {
addMemberForKeyType(getLiteralTypeFromPropertyName(prop, include), /*_index*/ undefined, prop);
addMemberForKeyType(getLiteralTypeFromPropertyName(prop, include));
}
if (modifiersType.flags & TypeFlags.Any || getIndexInfoOfType(modifiersType, IndexKind.String)) {
addMemberForKeyType(stringType);
@ -6668,7 +6668,7 @@ namespace ts {
}
setStructuredTypeMembers(type, members, emptyArray, emptyArray, stringIndexInfo, numberIndexInfo);
function addMemberForKeyType(t: Type, _index?: number, origin?: Symbol) {
function addMemberForKeyType(t: Type) {
// Create a mapper from T to the current iteration type constituent. Then, if the
// mapped type is itself an instantiated type, combine the iteration mapper with the
// instantiation mapper.
@ -6690,9 +6690,9 @@ namespace ts {
prop.type = strictNullChecks && isOptional && !isTypeAssignableTo(undefinedType, propType) ? getOptionalType(propType) :
strictNullChecks && !isOptional && modifiersProp && modifiersProp.flags & SymbolFlags.Optional ? getTypeWithFacts(propType, TypeFacts.NEUndefined) :
propType;
if (origin) {
prop.syntheticOrigin = origin;
prop.declarations = origin.declarations;
if (modifiersProp) {
prop.syntheticOrigin = modifiersProp;
prop.declarations = modifiersProp.declarations;
}
prop.nameType = t;
members.set(propName, prop);

12
tests/cases/fourslash/quickInfoMappedType.ts
View File

@ -1,11 +1,17 @@
/// <reference path="./fourslash.ts"/>
////interface I { m(): void; }
////interface I {
//// /** m documentation */ m(): void;
////}
////declare const o: { [K in keyof I]: number };
////o.m/*0*/;
////
////declare const p: { [K in keyof I]: I[K] };
////p.m/*1*/;
////
////declare const q: Pick<I, "m">;
////q.m/*2*/;
verify.quickInfoAt("0", "(property) m: number");
verify.quickInfoAt("1", "(method) m(): void");
verify.quickInfoAt("0", "(property) m: number", "m documentation");
verify.quickInfoAt("1", "(method) m(): void", "m documentation");
verify.quickInfoAt("2", "(method) m(): void", "m documentation");