core

Invoke your custom commands.

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

Classes

Channel

Defined in: packages/api/src/core.ts:77

Type Parameters

Type Parameter	Default type
T	unknown

Constructors

new Channel()

new Channel<T>(onmessage?): Channel<T>;

Defined in: packages/api/src/core.ts:87

Parameters

Parameter	Type
onmessage?	(response) => void

Returns

Channel<T>

Properties

Property	Type	Description	Defined in
id	number	The callback id returned from transformCallback	packages/api/src/core.ts:79

Accessors

onmessage

Get Signature

get onmessage(): (response) => void;

Defined in: packages/api/src/core.ts:142

Returns

(response) => void

Set Signature

set onmessage(handler): void;

Defined in: packages/api/src/core.ts:138

Parameters

Parameter	Type
handler	(response) => void

Returns

void

Methods

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): string;

Defined in: packages/api/src/core.ts:146

Returns

string

toJSON()

toJSON(): string;

Defined in: packages/api/src/core.ts:150

Returns

string

---

PluginListener

Defined in: packages/api/src/core.ts:156

Constructors

new PluginListener()

new PluginListener(
   plugin,
   event,
   channelId): PluginListener;

Defined in: packages/api/src/core.ts:161

Parameters

Parameter	Type
plugin	string
event	string
channelId	number

Returns

PluginListener

Properties

Property	Type	Defined in
channelId	number	packages/api/src/core.ts:159
event	string	packages/api/src/core.ts:158
plugin	string	packages/api/src/core.ts:157

Methods

unregister()

unregister(): Promise<void>;

Defined in: packages/api/src/core.ts:167

Returns

Promise<void>

---

Resource

Defined in: packages/api/src/core.ts:315

A rust-backed resource stored through tauri::Manager::resources_table API.

The resource lives in the main process and does not exist in the Javascript world, and thus will not be cleaned up automatically except on application exit. If you want to clean it up early, call Resource.close

Example

import { Resource, invoke } from '@tauri-apps/api/core';
export class DatabaseHandle extends Resource {
  static async open(path: string): Promise<DatabaseHandle> {
    const rid: number = await invoke('open_db', { path });
    return new DatabaseHandle(rid);
  }

  async execute(sql: string): Promise<void> {
    await invoke('execute_sql', { rid: this.rid, sql });
  }
}

Extended by

• Image
• TrayIcon

Constructors

new Resource()

new Resource(rid): Resource;

Defined in: packages/api/src/core.ts:322

Parameters

Parameter	Type
rid	number

Returns

Resource

Accessors

rid

Get Signature

get rid(): number;

Defined in: packages/api/src/core.ts:318

Returns

number

Methods

close()

close(): Promise<void>;

Defined in: packages/api/src/core.ts:330

Destroys and cleans up this resource from memory. You should not call any method on this object anymore and should drop any reference to it.

Returns

Promise<void>

Interfaces

InvokeOptions

Defined in: packages/api/src/core.ts:232

Since

2.0.0

Properties

Property	Type	Defined in
headers	HeadersInit	packages/api/src/core.ts:233

Type Aliases

InvokeArgs

type InvokeArgs =
  | Record<string, unknown>
  | number[]
  | ArrayBuffer
  | Uint8Array;

Defined in: packages/api/src/core.ts:227

Command arguments.

Since

1.0.0

---

PermissionState

type PermissionState = "granted" | "denied" | "prompt" | "prompt-with-rationale";

Defined in: packages/api/src/core.ts:202

Variables

SERIALIZE_TO_IPC_FN

const SERIALIZE_TO_IPC_FN: "__TAURI_TO_IPC_KEY__" = '__TAURI_TO_IPC_KEY__';

Defined in: packages/api/src/core.ts:59

A key to be used to implement a special function on your types that define how your type should be serialized when passing across the IPC.

Example

Given a type in Rust that looks like this

#[derive(serde::Serialize, serde::Deserialize)
enum UserId {
  String(String),
  Number(u32),
}

UserId::String("id") would be serialized into { String: "id" } and so we need to pass the same structure back to Rust

import { SERIALIZE_TO_IPC_FN } from "@tauri-apps/api/core"

class UserIdString {
  id
  constructor(id) {
    this.id = id
  }

  [SERIALIZE_TO_IPC_FN]() {
    return { String: this.id }
  }
}

class UserIdNumber {
  id
  constructor(id) {
    this.id = id
  }

  [SERIALIZE_TO_IPC_FN]() {
    return { Number: this.id }
  }
}

type UserId = UserIdString | UserIdNumber

Functions

addPluginListener()

function addPluginListener<T>(
   plugin,
   event,
cb): Promise<PluginListener>;

Defined in: packages/api/src/core.ts:182

Adds a listener to a plugin event.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
plugin	string
event	string
cb	(payload) => void

Returns

Promise<PluginListener>

The listener object to stop listening to the events.

Since

2.0.0

---

checkPermissions()

function checkPermissions<T>(plugin): Promise<T>;

Defined in: packages/api/src/core.ts:209

Get permission state for a plugin.

This should be used by plugin authors to wrap their actual implementation.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
plugin	string

Returns

Promise<T>

---

convertFileSrc()

function convertFileSrc(filePath, protocol?): string;

Defined in: packages/api/src/core.ts:289

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

Additionally, "enable" : "true" must be added to app.security.assetProtocol in tauri.conf.json and its access scope must be defined on the scope array on the same assetProtocol object.

Parameters

Parameter	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.

Example

import { appDataDir, join } from '@tauri-apps/api/path';
import { convertFileSrc } from '@tauri-apps/api/core';
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

---

invoke()

function invoke<T>(
   cmd,
   args?,
options?): Promise<T>;

Defined in: packages/api/src/core.ts:251

Sends a message to the backend.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
cmd	string	The command name.
args	InvokeArgs	The optional arguments to pass to the command.
options?	InvokeOptions	The request options.

Returns

Promise<T>

A promise resolving or rejecting to the backend response.

Example

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

Since

1.0.0

---

isTauri()

function isTauri(): boolean;

Defined in: packages/api/src/core.ts:337

Returns

boolean

---

requestPermissions()

function requestPermissions<T>(plugin): Promise<T>;

Defined in: packages/api/src/core.ts:218

Request permissions.

This should be used by plugin authors to wrap their actual implementation.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
plugin	string

Returns

Promise<T>

---

transformCallback()

function transformCallback<T>(callback?, once?): number;

Defined in: packages/api/src/core.ts:69

Stores the callback in a known location, and returns an identifier that can be passed to the backend. The backend uses the identifier to eval() the callback.

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type	Default value
callback?	(response) => void	undefined
once?	boolean	false

Returns

number

An unique identifier associated with the callback function.

Since

1.0.0