ScopeOptions — Kuito Documentation

Usage

Keep a presentation visible

This type is used by keepAwake

tsx

import { Video, keepAwake, app } from 'kuito';

function Player() {
  keepAwake(); // held while Player is mounted
  return <Video src={{ uri: 'https://example.com/movie.mp4' }} flex={1} />;
}

// For the app's life, outside any component; call the result to let go.
const release = keepAwake({ scope: app });
release();

Type declaration

export interface ScopeOptions {
  scope?: typeof appModule;
}

Members 1

Name	Type	Required	Description
`scope`	`typeof appModule`	No	—

scope — nested fields

scope fields

Name	Type	Required	Description
`watch`	`<E extends keyof Events>(event: E, listener: Events[E]) => EventSubscription`	Yes	Calls `listener` when the system warns that memory runs low. In a component it stops when the component unmounts; elsewhere the returned subscription stops it.
`state`	`ReadonlySignal<State>`	Yes	Whether the app is in the foreground. Watched, it follows the platform; starting to observe reports the state the platform starts from, which catches a change made in between. Default: `AppStateModule.state`
`openSettings`	`() => Promise<void>`	Yes	Opens this app's page in the system Settings. Default: `AppStateModule.openSettings`

watch — method signatures

Signatures

<E extends keyof Events>(event: E, listener: Events[E]): EventSubscription

Type parameters

Name	Constraint	Default
`E`	`"memoryWarning"`	—

Parameters

Name	Type	Required	Description
`event`	`E`	Yes	—
`listener`	`Events[E]`	Yes	—

Returns

EventSubscription

openSettings — method signatures

Signatures

(): Promise<void>

Parameters

No parameters.

Returns

Promise<void>

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.