microsoft / microsoft/tsdoc

How to declare a property is enumerable/configurable

Open
#295 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Description

There's @readonly for non-writeable properties, but I couldn't find any ways to declare enumerable and configurable. Do you accept PRs to add these features?

Contributor guide

No contributing guide indexed for this repository

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 by reviewing how the existing @readonly property is defined and documented in the TSDoc specification. The issue does not name a file, test, or entry point, so first identify where property modifiers are specified and how syntax proposals are evaluated. Done means a decided, documented approach for enumerable and configurable properties, with corresponding validation or examples if the project requires them.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.