Script
constScript:object
Type Declaration
Section titled “Type Declaration”alert: (
message,__namedParameters) =>Effect<void,never,never>
Waits until the user dismisses it. Interrupting the effect closes the dialog.
Parameters
Section titled “Parameters”message
Section titled “message”string
__namedParameters?
Section titled “__namedParameters?”DialogOptions = {}
Returns
Section titled “Returns”Effect<void, never, never>
beep: (
times) =>Effect<void,never,never>
Plays Mira’s chime times times and waits for the last one to finish. Interrupting the effect cuts it off.
Parameters
Section titled “Parameters”times?
Section titled “times?”number = 1
Returns
Section titled “Returns”Effect<void, never, never>
confirm
Section titled “confirm”confirm: (
message,__namedParameters) =>Effect<boolean,never,never>
True when confirmed, false when cancelled. Interrupting the effect closes the dialog.
Parameters
Section titled “Parameters”message
Section titled “message”string
__namedParameters?
Section titled “__namedParameters?”ConfirmOptions = {}
Returns
Section titled “Returns”Effect<boolean, never, never>
exit: (
__namedParameters) =>Effect<never>
Ends the script from any fiber. Cleanup runs first, then the logout, then the tab closes a second later.
Parameters
Section titled “Parameters”__namedParameters?
Section titled “__namedParameters?”ExitOptions = {}
Returns
Section titled “Returns”Effect<never>
inputs
Section titled “inputs”inputs: <
D>() =>InputValues<D>
The values this run started with. Pass typeof inputs to type them; Mira checks the values, not the type.
Type Parameters
Section titled “Type Parameters”Returns
Section titled “Returns”InputValues<D>
prompt
Section titled “prompt”prompt: (
message,__namedParameters) =>Effect<string|null,never,never>
The text as entered, or null when cancelled. Interrupting the effect closes the dialog.
Parameters
Section titled “Parameters”message
Section titled “message”string
__namedParameters?
Section titled “__namedParameters?”PromptOptions = {}
Returns
Section titled “Returns”Effect<string | null, never, never>
signal
Section titled “signal”signal:
AbortSignal=stopping.signal
Aborts when the script is stopped or exits, before cleanup runs, or when it ends.
sleep: (
duration) =>Effect<void,never,never>
Parameters
Section titled “Parameters”duration
Section titled “duration”Input
Returns
Section titled “Returns”Effect<void, never, never>