Skip to main content

@rtorcato/browser-common / permissions

permissions

Functions​

isPermissionsApiAvailable()​

isPermissionsApiAvailable(): boolean

Defined in: permissions/index.ts:9

Checks if the Permissions API is available in the current environment.

Example​

import { isPermissionsApiAvailable } from '@rtorcato/browser-common/permissions'
if (isPermissionsApiAvailable()) query()

Returns​

boolean

queryPermission()​

queryPermission(name): Promise<PermissionState | undefined>

Defined in: permissions/index.ts:23

Queries the status of a given permission name (e.g., 'geolocation', 'notifications').

Example​

import { queryPermission } from '@rtorcato/browser-common/permissions'
const state = await queryPermission('geolocation')

Parameters​

name​

PermissionName

The name of the permission to query.

Returns​

Promise<PermissionState | undefined>

A promise resolving to the permission status ('granted', 'denied', or 'prompt'), or undefined if not supported.

onPermissionChange()​

onPermissionChange(status, callback): () => void

Defined in: permissions/index.ts:46

Adds a change event listener to a permission status object.

Example​

import { onPermissionChange } from '@rtorcato/browser-common/permissions'
const status = await navigator.permissions.query({ name: 'geolocation' })
const off = onPermissionChange(status, () => console.log(status.state))
off()

Parameters​

status​

PermissionStatus

The PermissionStatus object.

callback​

() => void

The callback to run on change.

Returns​

A function to remove the event listener.

() => void