OverlayStatus
interface exported by @mwillbanks/tuil-ink.
interface
Public interface exported by @mwillbanks/tuil-ink.
export interface OverlayStatus {
readonly active: boolean;
readonly count: number;
readonly topId?: string;
readonly getTopId: () => string | undefined;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
active | boolean | Yes | The active member uses the boolean contract. | — |
count | number | Yes | The count member uses the number contract. | — |
topId | string | undefined | No | The topId member uses the string | undefined contract. | — |
getTopId | () => string | undefined | Yes | The getTopId member uses the () => string | undefined contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
No package-local related types.
Source
View the secondary source reference