Inconsistencies between documentation and TS types
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 213
- Forks
- 35
- Avg merge
- 37m
- Merged PRs (30d)
- 1
Description
This issue is regarding fire<EventName> and similar methods, which are marked as protected in official documentation, however they are public in TS types. Let's take an example:
sap.m.ComboBox
event: change
method: fireChange
API:
TS:
So it's either wrong in TS, or in official API.
Please let me know if it is official API issue, in such case I will create issue there.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the official API entry for sap.m.ComboBox's change event and fireChange method with the corresponding TypeScript declaration. Determine which source is inconsistent, then update the responsible artifact so the visibility matches and verify that the generated or published types and documentation agree.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100