Interface SystemAPI

interface SystemAPI {
    Sleep(ms: number): void;
    GetClipboard(): string;
    SetClipboard(text: string): void;
    Base64Encode(text: string): string;
    Base64Decode(base64: string): string;
}

Index

Methods

Sleep GetClipboard SetClipboard Base64Encode Base64Decode

Methods

Sleep

Sleep(ms: number): void
Blocks the script thread for the specified duration.
Parameters
- ms: number
  Duration to sleep in milliseconds.
Returns void
Remarks
Hotkey, hotstring, and window-activation callbacks continue to fire during sleep. The event loop remains active on the blocking thread.
Example
```
System.Sleep(500); // pause for half a second
```

GetClipboard

GetClipboard(): string
Reads the current text content of the system clipboard. Returns an empty string if no text is available.

Returns string
Remarks
Returns "" (empty string), never null, when the clipboard holds no text or holds non-text content such as an image.
Example
```
const text = System.GetClipboard();
if (text) Console.Log("Clipboard: " + text);
```
Requires
clipboard

SetClipboard

SetClipboard(text: string): void
Writes text to the system clipboard, replacing its current content.
Parameters
- text: string
  The text to place on the clipboard.
Returns void
Example
```
System.SetClipboard("Hello, world!");
```
Requires
clipboard

Base64Encode

Base64Encode(text: string): string
Encodes a UTF-8 string to its Base64 representation.
Parameters
- text: string
  The plain text to encode.
Returns string
The Base64-encoded string.
Example
```
const b64 = System.Base64Encode("hello"); // "aGVsbG8="
```

Base64Decode

Base64Decode(base64: string): string
Decodes a Base64 string back to UTF-8 text.
Parameters
- base64: string
  The Base64-encoded string.
Returns string
The decoded plain text.
Remarks
Throws a runtime error if the input is not valid Base64 or does not decode to valid UTF-8.
Example
```
const plain = System.Base64Decode("aGVsbG8="); // "hello"
```