BeyondCodeBootcamp / BeyondCodeBootcamp/js-with-types-jsdoc-tsc-starter

Docs: How to escape special characters in JSDoc property names

Open
#3 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
19
Forks
1
PR merge metrics
No merged PRs in 30d

Description

You'd never put `#` as an object name for a sane reason... but sometimes you have to deal with CSV. According to the JSDoc docs, it seems like this should do the job:

```js
/**
* @typedef {Object} EmpCsv
* @property {string} Emp#
* @property {string} "First Name"
*/
```

But I get errors...

Asked at https://stackoverflow.com/questions/68946492/how-can-i-escape-special-characters-names-in-jsdoc-typescript.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reproducing the JSDoc typedef and property declarations from the issue in this repository's JavaScript and tsserver setup. Compare the reported errors with the linked Stack Overflow question and document or test the syntax that correctly handles the special-character property names. Done means the example is accepted without the reported errors and the supported usage is clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.