Skip to content

feat(14417): add optionality to accessors #45662

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

Closed
wants to merge 1 commit into from
Closed
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
4 changes: 2 additions & 2 deletions src/compiler/binder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2637,9 +2637,9 @@ namespace ts {
case SyntaxKind.Constructor:
return declareSymbolAndAddToSymbolTable(node as Declaration, SymbolFlags.Constructor, /*symbolExcludes:*/ SymbolFlags.None);
case SyntaxKind.GetAccessor:
return bindPropertyOrMethodOrAccessor(node as Declaration, SymbolFlags.GetAccessor, SymbolFlags.GetAccessorExcludes);
return bindPropertyOrMethodOrAccessor(node as Declaration, SymbolFlags.GetAccessor | ((node as GetAccessorDeclaration).questionToken ? SymbolFlags.Optional : SymbolFlags.None), SymbolFlags.GetAccessorExcludes);
case SyntaxKind.SetAccessor:
return bindPropertyOrMethodOrAccessor(node as Declaration, SymbolFlags.SetAccessor, SymbolFlags.SetAccessorExcludes);
return bindPropertyOrMethodOrAccessor(node as Declaration, SymbolFlags.SetAccessor | ((node as SetAccessorDeclaration).questionToken ? SymbolFlags.Optional : SymbolFlags.None), SymbolFlags.SetAccessorExcludes);
case SyntaxKind.FunctionType:
case SyntaxKind.JSDocFunctionType:
case SyntaxKind.JSDocSignature:
Expand Down
13 changes: 8 additions & 5 deletions src/compiler/checker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5709,8 +5709,8 @@ namespace ts {
kind === SyntaxKind.MethodSignature ? factory.createMethodSignature(modifiers, options?.name ?? factory.createIdentifier(""), options?.questionToken, typeParameters, parameters, returnTypeNode) :
kind === SyntaxKind.MethodDeclaration ? factory.createMethodDeclaration(/*decorators*/ undefined, modifiers, /*asteriskToken*/ undefined, options?.name ?? factory.createIdentifier(""), /*questionToken*/ undefined, typeParameters, parameters, returnTypeNode, /*body*/ undefined) :
kind === SyntaxKind.Constructor ? factory.createConstructorDeclaration(/*decorators*/ undefined, modifiers, parameters, /*body*/ undefined) :
kind === SyntaxKind.GetAccessor ? factory.createGetAccessorDeclaration(/*decorators*/ undefined, modifiers, options?.name ?? factory.createIdentifier(""), parameters, returnTypeNode, /*body*/ undefined) :
kind === SyntaxKind.SetAccessor ? factory.createSetAccessorDeclaration(/*decorators*/ undefined, modifiers, options?.name ?? factory.createIdentifier(""), parameters, /*body*/ undefined) :
kind === SyntaxKind.GetAccessor ? factory.createGetAccessorDeclaration(/*decorators*/ undefined, modifiers, options?.name ?? factory.createIdentifier(""), parameters, returnTypeNode, /*questionToken*/ undefined, /*body*/ undefined) :
kind === SyntaxKind.SetAccessor ? factory.createSetAccessorDeclaration(/*decorators*/ undefined, modifiers, options?.name ?? factory.createIdentifier(""), parameters, /*questionToken*/ undefined, /*body*/ undefined) :
kind === SyntaxKind.IndexSignature ? factory.createIndexSignature(/*decorators*/ undefined, modifiers, parameters, returnTypeNode) :
kind === SyntaxKind.JSDocFunctionType ? factory.createJSDocFunctionType(parameters, returnTypeNode) :
kind === SyntaxKind.FunctionType ? factory.createFunctionTypeNode(typeParameters, parameters, returnTypeNode ?? factory.createTypeReferenceNode(factory.createIdentifier(""))) :
Expand Down Expand Up @@ -7787,6 +7787,7 @@ namespace ts {
/*questionToken*/ undefined,
isPrivate ? undefined : serializeTypeForDeclaration(context, getTypeOfSymbol(p), p, enclosingDeclaration, includePrivateSymbol, bundled)
)],
/*questionToken*/ undefined,
/*body*/ undefined
), p.declarations?.find(isSetAccessor) || firstPropertyLikeDecl));
}
Expand All @@ -7798,6 +7799,7 @@ namespace ts {
name,
[],
isPrivate ? undefined : serializeTypeForDeclaration(context, getTypeOfSymbol(p), p, enclosingDeclaration, includePrivateSymbol, bundled),
/*questionToken*/ undefined,
/*body*/ undefined
), p.declarations?.find(isGetAccessor) || firstPropertyLikeDecl));
}
Expand Down Expand Up @@ -9496,15 +9498,14 @@ namespace ts {
}

let type = resolveTypeOfAccessors(symbol, writing);

if (!popTypeResolution()) {
type = anyType;
if (noImplicitAny) {
const getter = getDeclarationOfKind<AccessorDeclaration>(symbol, SyntaxKind.GetAccessor);
error(getter, Diagnostics._0_implicitly_has_return_type_any_because_it_does_not_have_a_return_type_annotation_and_is_referenced_directly_or_indirectly_in_one_of_its_return_expressions, symbolToString(symbol));
}
}
return type;
return type ? addOptionality(type, /*isProperty*/ true, !!(symbol.flags & SymbolFlags.Optional)) : undefined;
}

function resolveTypeOfAccessors(symbol: Symbol, writing = false) {
Expand Down Expand Up @@ -43241,9 +43242,11 @@ namespace ts {
currentKind = DeclarationMeaning.Method;
break;
case SyntaxKind.GetAccessor:
checkGrammarForInvalidQuestionMark(prop.questionToken, Diagnostics.An_object_member_cannot_be_declared_optional);
currentKind = DeclarationMeaning.GetAccessor;
break;
case SyntaxKind.SetAccessor:
checkGrammarForInvalidQuestionMark(prop.questionToken, Diagnostics.An_object_member_cannot_be_declared_optional);
currentKind = DeclarationMeaning.SetAccessor;
break;
default:
Expand Down Expand Up @@ -43430,7 +43433,7 @@ namespace ts {
if (languageVersion < ScriptTarget.ES2015 && isPrivateIdentifier(accessor.name)) {
return grammarErrorOnNode(accessor.name, Diagnostics.Private_identifiers_are_only_available_when_targeting_ECMAScript_2015_and_higher);
}
if (accessor.body === undefined && !hasSyntacticModifier(accessor, ModifierFlags.Abstract)) {
if (accessor.body === undefined && !hasQuestionToken(accessor) && !hasSyntacticModifier(accessor, ModifierFlags.Abstract)) {
return grammarErrorAtPos(accessor, accessor.end - 1, ";".length, Diagnostics._0_expected, "{");
}
}
Expand Down
1 change: 1 addition & 0 deletions src/compiler/emitter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2108,6 +2108,7 @@ namespace ts {
writeKeyword(node.kind === SyntaxKind.GetAccessor ? "get" : "set");
writeSpace();
emit(node.name);
emit(node.questionToken);
emitSignatureAndBody(node, emitSignatureHead);
}

Expand Down
23 changes: 17 additions & 6 deletions src/compiler/factory/nodeFactory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1502,9 +1502,10 @@ namespace ts {
name: string | PropertyName,
parameters: readonly ParameterDeclaration[],
type: TypeNode | undefined,
questionToken: QuestionToken | undefined,
body: Block | undefined
) {
return createBaseFunctionLikeDeclaration<GetAccessorDeclaration>(
const node = createBaseFunctionLikeDeclaration<GetAccessorDeclaration>(
SyntaxKind.GetAccessor,
decorators,
modifiers,
Expand All @@ -1514,6 +1515,8 @@ namespace ts {
type,
body
);
node.questionToken = questionToken;
return node;
}

// @api
Expand All @@ -1524,15 +1527,17 @@ namespace ts {
name: PropertyName,
parameters: readonly ParameterDeclaration[],
type: TypeNode | undefined,
questionToken: QuestionToken | undefined,
body: Block | undefined
) {
return node.decorators !== decorators
|| node.modifiers !== modifiers
|| node.name !== name
|| node.parameters !== parameters
|| node.questionToken !== questionToken
|| node.type !== type
|| node.body !== body
? updateBaseFunctionLikeDeclaration(createGetAccessorDeclaration(decorators, modifiers, name, parameters, type, body), node)
? updateBaseFunctionLikeDeclaration(createGetAccessorDeclaration(decorators, modifiers, name, parameters, type, questionToken, body), node)
: node;
}

Expand All @@ -1542,9 +1547,10 @@ namespace ts {
modifiers: readonly Modifier[] | undefined,
name: string | PropertyName,
parameters: readonly ParameterDeclaration[],
questionToken: QuestionToken | undefined,
body: Block | undefined
) {
return createBaseFunctionLikeDeclaration<SetAccessorDeclaration>(
const node = createBaseFunctionLikeDeclaration<SetAccessorDeclaration>(
SyntaxKind.SetAccessor,
decorators,
modifiers,
Expand All @@ -1554,6 +1560,8 @@ namespace ts {
/*type*/ undefined,
body
);
node.questionToken = questionToken;
return node;
}

// @api
Expand All @@ -1563,14 +1571,16 @@ namespace ts {
modifiers: readonly Modifier[] | undefined,
name: PropertyName,
parameters: readonly ParameterDeclaration[],
questionToken: QuestionToken | undefined,
body: Block | undefined
) {
return node.decorators !== decorators
|| node.modifiers !== modifiers
|| node.name !== name
|| node.parameters !== parameters
|| node.questionToken !== questionToken
|| node.body !== body
? updateBaseFunctionLikeDeclaration(createSetAccessorDeclaration(decorators, modifiers, name, parameters, body), node)
? updateBaseFunctionLikeDeclaration(createSetAccessorDeclaration(decorators, modifiers, name, parameters, questionToken, body), node)
: node;
}

Expand Down Expand Up @@ -5755,6 +5765,7 @@ namespace ts {
/*type*/ undefined,
/*initializer*/ undefined
)],
/*questionToken*/ undefined,
createBlock([
createExpressionStatement(expression)
])
Expand Down Expand Up @@ -6094,8 +6105,8 @@ namespace ts {
isMethodSignature(node) ? updateMethodSignature(node, modifierArray, node.name, node.questionToken, node.typeParameters, node.parameters, node.type) :
isMethodDeclaration(node) ? updateMethodDeclaration(node, node.decorators, modifierArray, node.asteriskToken, node.name, node.questionToken, node.typeParameters, node.parameters, node.type, node.body) :
isConstructorDeclaration(node) ? updateConstructorDeclaration(node, node.decorators, modifierArray, node.parameters, node.body) :
isGetAccessorDeclaration(node) ? updateGetAccessorDeclaration(node, node.decorators, modifierArray, node.name, node.parameters, node.type, node.body) :
isSetAccessorDeclaration(node) ? updateSetAccessorDeclaration(node, node.decorators, modifierArray, node.name, node.parameters, node.body) :
isGetAccessorDeclaration(node) ? updateGetAccessorDeclaration(node, node.decorators, modifierArray, node.name, node.parameters, node.type, node.questionToken, node.body) :
isSetAccessorDeclaration(node) ? updateSetAccessorDeclaration(node, node.decorators, modifierArray, node.name, node.parameters, node.questionToken, node.body) :
isIndexSignatureDeclaration(node) ? updateIndexSignature(node, node.decorators, modifierArray, node.parameters, node.type) :
isFunctionExpression(node) ? updateFunctionExpression(node, modifierArray, node.asteriskToken, node.name, node.typeParameters, node.parameters, node.type, node.body) :
isArrowFunction(node) ? updateArrowFunction(node, modifierArray, node.typeParameters, node.parameters, node.type, node.equalsGreaterThanToken, node.body) :
Expand Down
5 changes: 3 additions & 2 deletions src/compiler/parser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6747,13 +6747,14 @@ namespace ts {

function parseAccessorDeclaration(pos: number, hasJSDoc: boolean, decorators: NodeArray<Decorator> | undefined, modifiers: NodeArray<Modifier> | undefined, kind: AccessorDeclaration["kind"]): AccessorDeclaration {
const name = parsePropertyName();
const questionToken = parseOptionalToken(SyntaxKind.QuestionToken);
const typeParameters = parseTypeParameters();
const parameters = parseParameters(SignatureFlags.None);
const type = parseReturnType(SyntaxKind.ColonToken, /*isType*/ false);
const body = parseFunctionBlockOrSemicolon(SignatureFlags.None);
const node = kind === SyntaxKind.GetAccessor
? factory.createGetAccessorDeclaration(decorators, modifiers, name, parameters, type, body)
: factory.createSetAccessorDeclaration(decorators, modifiers, name, parameters, body);
? factory.createGetAccessorDeclaration(decorators, modifiers, name, parameters, type, questionToken, body)
: factory.createSetAccessorDeclaration(decorators, modifiers, name, parameters, questionToken, body);
// Keep track of `typeParameters` (for both) and `type` (for setters) if they were parsed those indicate grammar errors
node.typeParameters = typeParameters;
if (type && node.kind === SyntaxKind.SetAccessor) (node as Mutable<SetAccessorDeclaration>).type = type;
Expand Down
2 changes: 2 additions & 0 deletions src/compiler/transformers/declarations.ts
Original file line number Diff line number Diff line change
Expand Up @@ -950,6 +950,7 @@ namespace ts {
input.name,
updateAccessorParamsList(input, hasEffectiveModifier(input, ModifierFlags.Private)),
ensureType(input, accessorType),
input.questionToken,
/*body*/ undefined));
}
case SyntaxKind.SetAccessor: {
Expand All @@ -962,6 +963,7 @@ namespace ts {
ensureModifiers(input),
input.name,
updateAccessorParamsList(input, hasEffectiveModifier(input, ModifierFlags.Private)),
input.questionToken,
/*body*/ undefined));
}
case SyntaxKind.PropertyDeclaration:
Expand Down
4 changes: 2 additions & 2 deletions src/compiler/transformers/es2015.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3649,10 +3649,10 @@ namespace ts {
const parameters = visitParameterList(node.parameters, visitor, context);
const body = transformFunctionBody(node);
if (node.kind === SyntaxKind.GetAccessor) {
updated = factory.updateGetAccessorDeclaration(node, node.decorators, node.modifiers, node.name, parameters, node.type, body);
updated = factory.updateGetAccessorDeclaration(node, node.decorators, node.modifiers, node.name, parameters, node.type, node.questionToken, body);
}
else {
updated = factory.updateSetAccessorDeclaration(node, node.decorators, node.modifiers, node.name, parameters, body);
updated = factory.updateSetAccessorDeclaration(node, node.decorators, node.modifiers, node.name, parameters, node.questionToken, body);
}
exitSubtree(ancestorFacts, HierarchyFacts.FunctionSubtreeExcludes, HierarchyFacts.None);
convertedLoopState = savedConvertedLoopState;
Expand Down
2 changes: 2 additions & 0 deletions src/compiler/transformers/es2018.ts
Original file line number Diff line number Diff line change
Expand Up @@ -864,6 +864,7 @@ namespace ts {
visitNode(node.name, visitor, isPropertyName),
visitParameterList(node.parameters, parameterVisitor, context),
/*type*/ undefined,
visitNode<Token<SyntaxKind.QuestionToken>>(/*questionToken*/ undefined, visitor, isToken),
transformFunctionBody(node)
);
enclosingFunctionFlags = savedEnclosingFunctionFlags;
Expand All @@ -882,6 +883,7 @@ namespace ts {
node.modifiers,
visitNode(node.name, visitor, isPropertyName),
visitParameterList(node.parameters, parameterVisitor, context),
visitNode<Token<SyntaxKind.QuestionToken>>(/*questionToken*/ undefined, visitor, isToken),
transformFunctionBody(node)
);
enclosingFunctionFlags = savedEnclosingFunctionFlags;
Expand Down
2 changes: 2 additions & 0 deletions src/compiler/transformers/ts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2070,6 +2070,7 @@ namespace ts {
visitPropertyNameOfClassElement(node),
visitParameterList(node.parameters, visitor, context),
/*type*/ undefined,
/*questionToken*/ undefined,
visitFunctionBody(node.body, visitor, context) || factory.createBlock([])
);
if (updated !== node) {
Expand All @@ -2091,6 +2092,7 @@ namespace ts {
visitNodes(node.modifiers, modifierVisitor, isModifier),
visitPropertyNameOfClassElement(node),
visitParameterList(node.parameters, visitor, context),
/*questionToken*/ undefined,
visitFunctionBody(node.body, visitor, context) || factory.createBlock([])
);
if (updated !== node) {
Expand Down
Loading