microsoft / microsoft/TypeScript
Type PermissionName for Permission API doesn't contain microphone and camera devices
@sandersn arbeitet bereits daran.
Seit 30.8.2024.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.4k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
🔍 Search Terms
microphone, camera, device, permission, state, API, navigator
✅ Viability Checklist
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
⭐ Suggestion
In both files, webworker.generated.d.ts and dom.generated.d.ts in line 9361 and 27992.
The modification would be add two terms in the type PermissionName. 'camera' and 'microphone' to check access in both devices
📃 Motivating Example
const checkForPermission = (type: PermissionName) => {
navigator.permissions
.query({
name: type,
})
.then(permissionStatus => {
// Will be 'granted', 'denied' or 'prompt':
console.log(permissionStatus);
// permissionStatus.state = 'granted'
// Listen for changes to the permission state
permissionStatus.onchange = () => {
console.log(permissionStatus.state);
};
});
};
checkForPermission('microphone');
checkForPermission('camera');
Expected behavior:
'microphone' and 'camera' should be valid types for PermissionName type.
Actual behavior:
'microphone' and 'camera' are not valid types for PermissionName type.
Typescript is showing error:
Argument of type '"microphone"' is not assignable to parameter of type 'PermissionName'.
💻 Use Cases
-
What do you want to use this for?
Check if camera or microphone are enabled/disabled -
What shortcomings exist with current approaches?
To type the promise from navigator.permission in typescript, we have to add a inclusion on type PermissionName like: { PermissionName } & { name: 'camera' | 'microphone' }. -
What workarounds are you using in the meantime?
I'm using it: { PermissionName } & { name: 'camera' | 'microphone' }
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Bewertung
Dieses Issue wurde noch nicht bewertet.