@tauri-apps/plugin-autostart

Automatically launch your application at startup.

Functions

disable()

function disable(): Promise<void>;

Defined in: plugins/autostart/guest-js/index.ts:52

Disables autostart for the application.

Example

import { disable } from '@tauri-apps/plugin-autostart';
await disable();

Returns

Promise<void>

Since

2.0.0

---

enable()

function enable(): Promise<void>;

Defined in: plugins/autostart/guest-js/index.ts:38

Enables autostart for the application.

Example

import { enable } from '@tauri-apps/plugin-autostart';
await enable();

Returns

Promise<void>

Since

2.0.0

---

isEnabled()

function isEnabled(): Promise<boolean>;

Defined in: plugins/autostart/guest-js/index.ts:24

Checks whether autostart is enabled for the application.

Example

import { isEnabled } from '@tauri-apps/plugin-autostart';
const enabled = await isEnabled();

Returns

Promise<boolean>

A promise resolving to true if the application launches at startup, false otherwise.

Since

2.0.0