OpenAPITools / OpenAPITools/openapi-generator

implicit conversion of symbol to string error in TypeScript-Aurelia template ts(2731)

Open Beginner friendly
#17,253 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Description

Generation of the typescript-aurelia code results in an error from typescript as follows.

Implicit conversion of a 'symbol' to a 'string' will fail at runtime. Consider wrapping this expression in 'String(...)'.ts(2731)

Error is in output file 'Api.ts' as shown below:
image

The change to typescript that picks up this problem is documented here:
https://devblogs.microsoft.com/typescript/announcing-typescript-4-7-rc/#stricter-checks-with-template-string-expressions

openapi-generator version

@openapitools/openapi-generator-cli": "^2.7.0"

OpenAPI declaration file content or url

modules/openapi-generator/src/main/resources/typescript-aurelia/Api.ts.mustache

Generation Details
Steps to reproduce

Generate an api client as documented. Does not matter the server side code as the error is in the template.

 # Update the api to a specific version 
 npx @openapitools/openapi-generator-cli generate -i 'https://localhost:44348/v4.0/swagger' -g typescript-aurelia -o './src/resources/bookings-api-client'
Suggest a fix

Solution is to do as suggested and wrap the symbol conversion in the string constructor String(..)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with modules/openapi-generator/src/main/resources/typescript-aurelia/Api.ts.mustache and reproduce the issue using the documented npx generation command. Inspect the generated Api.ts around the reported template expression. Done means the generated TypeScript-Aurelia client no longer produces the ts(2731) implicit symbol-to-string error.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
70/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.