`@sapui5/ts-types-esm` - `CrossApplicationNavigation.hrefForExternal` should be an overload that can return a `Promise<string>`
Open
Nobody has claimed this yet.
types
wontfix
- Dominant language
- TypeScript
- Stars
- 213
- Forks
- 35
- Avg merge
- 37m
- Merged PRs (30d)
- 1
Description
i'm not sure if this is something that can be fixed in the docs at https://github.com/SAP/openui5, but according to the docs regarding the bAsync parameter:
if set to
true, a promise will be returned instead of the direct argument.
so the overload should be something like:
hrefForExternal(oArgs: object, bAsync: true): Promise<string>;
hrefForExternal(oArgs: object, bAsync: false): string;
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
Start with the CrossApplicationNavigation.hrefForExternal entry in the SAPUI5 API documentation and locate its declaration in the @sapui5/ts-types-esm package. Verify the bAsync behavior, then ensure the type distinguishes Promise for true from string for false; the documentation's two return paths define done.
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
- Mostly clear
- Newbie friendliness
- 35/100