useWakeLock

类别

浏览器

导出大小

991 B

演示

源码

是否支持: false

是否激活: false

用法

import { useWakeLock } from '@vueuse/core'

const { isSupported, isActive, forceRequest, request, release } = useWakeLock()

当调用 request 时，如果文档可见，则会请求唤醒锁。否则，请求将排队，直到文档变为可见。如果请求成功，isActive 将为 true。每当文档隐藏时，isActive 将为 false。

当调用 release 时，唤醒锁将被释放。如果存在排队的请求，它将被取消。

要立即请求唤醒锁，即使文档隐藏，请使用 forceRequest。请注意，如果文档隐藏，这可能会抛出错误。

类型声明

typescript

type WakeLockType = "screen"
export interface WakeLockSentinel extends EventTarget {
  type: WakeLockType
  released: boolean
  release: () => Promise<void>
}
export type UseWakeLockOptions = ConfigurableNavigator & ConfigurableDocument
/**
 * Reactive Screen Wake Lock API.
 *
 * @see https://vueuse.org.cn/useWakeLock
 * @param options
 */
export declare function useWakeLock(options?: UseWakeLockOptions): {
  sentinel: ShallowRef<WakeLockSentinel | null, WakeLockSentinel | null>
  isSupported: ComputedRef<boolean>
  isActive: ComputedRef<boolean>
  request: (type: WakeLockType) => Promise<void>
  forceRequest: (type: WakeLockType) => Promise<void>
  release: () => Promise<void>
}
export type UseWakeLockReturn = ReturnType<typeof useWakeLock>