시작하기

설치

bun add @capgo/capacitor-keep-awake
bunx cap sync

수입

import { KeepAwake } from '@capgo/capacitor-keep-awake';

API Overview

keepAwake

화면을 어둡게 하지 않도록 장치로부터 방지합니다.

import { KeepAwake } from '@capgo/capacitor-keep-awake';

await KeepAwake.keepAwake();
console.log('Screen will stay awake');

allowSleep

화면을 어둡게 하도록 장치에 허용합니다 (keep awake 비활성화).

import { KeepAwake } from '@capgo/capacitor-keep-awake';

await KeepAwake.allowSleep();
console.log('Screen can now dim');

isSupported

현재 플랫폼에서 keep awake 기능이 지원되는지 확인합니다.

import { KeepAwake } from '@capgo/capacitor-keep-awake';

const { isSupported } = await KeepAwake.isSupported();
if (isSupported) {
  console.log('Keep awake is supported');
}

isKeptAwake

장치가 현재 keep awake 상태인지 확인합니다.

import { KeepAwake } from '@capgo/capacitor-keep-awake';

const { isKeptAwake } = await KeepAwake.isKeptAwake();
console.log('Is kept awake:', isKeptAwake);

타입 참조

IsSupportedResult

isSupported() 메서드의 결과

export interface IsSupportedResult {
  /**
   * Whether keep awake is supported on the current platform.
   *
   * @since 1.0.0
   */
  isSupported: boolean;
}

IsKeptAwakeResult

isKeptAwake() 메서드의 결과

export interface IsKeptAwakeResult {
  /**
   * Whether the device is currently being kept awake.
   *
   * @since 1.0.0
   */
  isKeptAwake: boolean;
}

진실의 근원

이 페이지는 플러그인의 소스에서 생성되었습니다. src/definitions.ts. upstream API이 변경될 때 다시 동기화 하세요.