@lynx-js/lynxtron / Shell

#Shell

#Methods

#beep()

beep(): void

Play the beep sound.

Returns

void

Defined in

apis/api/shell.d.ts:69

#openExternal()

openExternal(url: string, options?: OpenExternalOptions): Promise<void>

Open the given external protocol URL in the desktop's default manner. (For example, mailto: URLs in the user's default mail agent).

Parameters

Returns

Promise<void>

Defined in

apis/api/shell.d.ts:74

#openPath()

openPath(path: string): Promise<string>

Resolves with a string containing the error message corresponding to the failure if a failure occurred, otherwise "".

Open the given file in the desktop's default manner.

Parameters

Returns

Promise<string>

Defined in

apis/api/shell.d.ts:81

#readShortcutLink()

Windows

readShortcutLink(shortcutPath: string): ShortcutDetails

Resolves the shortcut link at shortcutPath.

An exception will be thrown when any error happens.

Parameters

Returns

ShortcutDetails

Defined in

apis/api/shell.d.ts:89

#showItemInFolder()

showItemInFolder(fullPath: string): void

Show the given file in a file manager. If possible, select the file.

Parameters

Returns

void

Defined in

apis/api/shell.d.ts:93

#trashItem()

trashItem(path: string): Promise<void>

Resolves when the operation has been completed. Rejects if there was an error while deleting the requested item.

This moves a path to the OS-specific trash location (Trash on macOS, Recycle Bin on Windows, and a desktop-environment-specific location on Linux).

Parameters

Returns

Promise<void>

Defined in

apis/api/shell.d.ts:101

#writeShortcutLink()

#operation: "create" | "update" | "replace"

Windows

writeShortcutLink(
   shortcutPath: string,
   operation: "create" | "update" | "replace",
   options: ShortcutDetails): boolean

Whether the shortcut was created successfully.

Creates or updates a shortcut link at shortcutPath.

Parameters

Returns

boolean

Defined in

apis/api/shell.d.ts:109

#options: ShortcutDetails

Windows

writeShortcutLink(shortcutPath: string, options: ShortcutDetails): boolean

Whether the shortcut was created successfully.

Creates or updates a shortcut link at shortcutPath.

Parameters

Returns

boolean

Defined in

apis/api/shell.d.ts:121