@tauri-apps/api

What is @tauri-apps/api?

@tauri-apps/api is a collection of APIs for building desktop applications using web technologies. It provides a bridge between the frontend and the backend, allowing developers to interact with the operating system and native functionalities from a web-based interface.

What are @tauri-apps/api's main functionalities?

Filesystem

The Filesystem API allows you to read and write files on the user's system. This can be useful for saving user data or configuration files.

const { readTextFile, writeFile } = require('@tauri-apps/api/fs');

async function readFile() {
  const content = await readTextFile('path/to/file.txt');
  console.log(content);
}

async function writeFile() {
  await writeFile({ path: 'path/to/file.txt', contents: 'Hello, World!' });
}

Window

The Window API allows you to control the properties of the application window, such as its title and size. This can be useful for customizing the user interface.

const { appWindow } = require('@tauri-apps/api/window');

appWindow.setTitle('New Title');
appWindow.setSize({ width: 800, height: 600 });

Dialog

The Dialog API allows you to open native dialog windows, such as file open/save dialogs. This can be useful for getting user input or selecting files.

const { open } = require('@tauri-apps/api/dialog');

async function openFileDialog() {
  const selected = await open({ multiple: true });
  console.log(selected);
}

Notification

The Notification API allows you to send native notifications to the user's system. This can be useful for alerting users to important events or updates.

const { sendNotification } = require('@tauri-apps/api/notification');

sendNotification('Hello, this is a notification!');

Process

The Process API allows you to run system commands and interact with the operating system's shell. This can be useful for performing tasks that require system-level access.

const { Command } = require('@tauri-apps/api/shell');

async function runCommand() {
  const command = new Command('echo', ['Hello, World!']);
  const output = await command.execute();
  console.log(output.stdout);
}

Other packages similar to @tauri-apps/api

electron

Electron is a framework for building cross-platform desktop applications with web technologies. It provides a rich set of APIs for interacting with the operating system, similar to @tauri-apps/api, but is generally heavier in terms of resource usage.

README

The README file is missing