Empezar

Copie una línea de comando con los pasos de instalación y la guía de markdown completa para este plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-keep-awake`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/keep-awake/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Instalar

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

Importar

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

API Resumen

`keepAwake`

Evita que el dispositivo reduzca la intensidad de la pantalla.

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

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

`allowSleep`

Permitir que el dispositivo reduzca la intensidad de la pantalla (desactivar mantenerse despierto).

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

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

`isSupported`

Comprobar si la característica mantenerse despierto está soportada en la plataforma actual.

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

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

`isKeptAwake`

Comprobar si el dispositivo está siendo actualmente mantenido despierto.

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

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

Referencia de tipos

`IsSupportedResult`

Resultado del método isSupported().

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

`IsKeptAwakeResult`

Resultado del método isKeptAwake().

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

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.tsRe-ruta la sincronización cuando los cambios públicos API cambian en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Empezando para planificar la consola y API operaciones, conecte con Usando @capgo/capacitor-keep-awake para la capacidad nativa en Usando @capgo/capacitor-keep-awake, Resumen de API para el detalle de implementación en Resumen de API, Introducción para el detalle de implementación en Introducción, Claves de API para el detalle de implementación en Claves de API, y Dispositivos para el detalle de implementación en Dispositivos.