apache / apache/cordova-docs

exitApp should be documented

Open
#1,242 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
353
Forks
565
Avg merge
7h 15m
Merged PRs (30d)
5

Description

A lot of use use the `window.navigator.app.exitApp` functionality.
I think the entire `window.navigator.app` API should be documented. This will make it clear if it's a public facing API or not.
This will also open up the possibility of adding in [typescript definitions](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cordova).

I can't find another better built-in replacement for this API. There is at least [one reference](https://cordova.apache.org/docs/en/11.x/reference/cordova-plugin-splashscreen/#:~:text=navigator.app.exitApp()) in the current documentation to this api. I think there were more references in previous versions of the Cordova documentation.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing Cordova documentation, especially the splashscreen reference to navigator.app.exitApp(), and determine where the window.navigator.app API is documented. Inventory the API surface covered by the issue, clarify whether it is public, and consider the linked TypeScript definitions as context. Done means the relevant API is documented with its public status made clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.