tauri

Invoke your custom commands.

This package is also accessible with window.__TAURI__.tauri when build.withGlobalTauri in tauri.conf.json is set to true.

Type Aliases

InvokeArgs

InvokeArgs: Record<string, unknown>

Command arguments.

Since: 1.0.0

Defined in: tauri.ts:66

Functions

convertFileSrc

convertFileSrc(filePath: string, protocol?: string): string

Convert a device file path to an URL that can be loaded by the webview. Note that asset: and https://asset.localhost must be added to tauri.security.csp in tauri.conf.json. Example CSP value: "csp": "default-src 'self'; img-src 'self' asset: https://asset.localhost" to use the asset protocol on image sources.

Additionally, asset must be added to tauri.allowlist.protocol in tauri.conf.json and its access scope must be defined on the assetScope array on the same protocol object. For example:

{
  "tauri": {
    "allowlist": {
      "protocol": {
        "asset": true,
        "assetScope": ["$APPDATA/assets/*"]
      }
    }
  }
}

Example

import { appDataDir, join } from '@tauri-apps/api/path';
import { convertFileSrc } from '@tauri-apps/api/tauri';
const appDataDirPath = await appDataDir();
const filePath = await join(appDataDirPath, 'assets/video.mp4');
const assetUrl = convertFileSrc(filePath);

const video = document.getElementById('my-video');
const source = document.createElement('source');
source.type = 'video/mp4';
source.src = assetUrl;
video.appendChild(source);
video.load();

Since: 1.0.0

Parameters

Name	Type	Default value	Description
filePath	string	undefined	The file path.
protocol	string	'asset'	The protocol to use. Defaults to asset. You only need to set this when using a custom protocol.

Returns: string

the URL that can be used as source on the webview.

invoke

invoke<T>(cmd: string, args?: InvokeArgs): Promise<T>

Sends a message to the backend.

Example

import { invoke } from '@tauri-apps/api/tauri';
await invoke('login', { user: 'tauri', password: 'poiwe3h4r5ip3yrhtew9ty' });

Since: 1.0.0

Type parameters

• T

Parameters

Name	Type	Description
cmd	string	The command name.
args	InvokeArgs	The optional arguments to pass to the command.

Returns: Promise<T>

A promise resolving or rejecting to the backend response.

transformCallback

transformCallback(callback?: fn, once?: boolean): number

Transforms a callback function to a string identifier that can be passed to the backend. The backend uses the identifier to eval() the callback.

Since: 1.0.0

Parameters

Name	Type	Default value
callback?	(response: any) => void	undefined
once	boolean	false

Returns: number

A unique identifier associated with the callback function.