core

Invoca tus comandos personalizados.

Este paquete también es accesible con window.__TAURI__.core cuando app.withGlobalTauri en tauri.conf.json está establecido en true.

Clases

Channel<T>

Parámetros de tipo

Parámetro de tipo	Tipo por defecto
T	unknown

Constructores

new Channel()

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

Parámetros

Parámetro	Tipo
onmessage?	(response) => void

Devuelve

Channel<T>

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L87

Propiedades

Propiedad	Tipo	Descripción	Definido en
id	number	El id de callback devuelto desde transformCallback	Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L79

Accesores

onmessage

get onmessage(): (response) => void

set onmessage(handler): void

Parámetros

Parámetro	Tipo
handler	(response) => void

Devuelve

Function

Parámetros

Parámetro	Tipo
response	T

Devuelve

void

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L142

Métodos

__TAURI_TO_IPC_KEY__()

__TAURI_TO_IPC_KEY__(): string

Devuelve

string

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L146

toJSON()

toJSON(): string

Devuelve

string

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L150

---

PluginListener

Constructores

new PluginListener()

new PluginListener(
   plugin,
   event,
   channelId): PluginListener

Parámetros

Parámetro	Tipo
plugin	string
event	string
channelId	number

Devuelve

PluginListener

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L161

Propiedades

Propiedad	Tipo	Definido en
channelId	number	Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L159
event	string	Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L158
plugin	string	Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L157

Métodos

unregister()

unregister(): Promise<void>

Devuelve

Promise<void>

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L167

---

Resource

Un recurso respaldado por Rust almacenado a través de la API tauri::Manager::resources_table.

El recurso vive en el proceso principal y no existe en el mundo de JavaScript, por lo que no se limpiará automáticamente excepto al salir de la aplicación. Si quieres limpiarlo antes, llama a Resource.close

Ejemplo

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 });
  }
}

Extendido por

• Image
• TrayIcon

Constructores

new Resource()

new Resource(rid): Resource

Parámetros

Parámetro	Tipo
rid	number

Devuelve

Resource

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L322

Accesores

rid

get rid(): number

Devuelve

number

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L318

Métodos

close()

close(): Promise<void>

Destruye y limpia este recurso de la memoria. Ya no deberías llamar a ningún método de este objeto y deberías descartar cualquier referencia a él.

Devuelve

Promise<void>

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L330

Interfaces

InvokeOptions

Desde

2.0.0

Propiedades

Propiedad	Tipo	Definido en
headers	HeadersInit	Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L233

Alias de tipos

InvokeArgs

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

Argumentos del comando.

Desde

1.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L227

---

PermissionState

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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L202

Variables

SERIALIZE_TO_IPC_FN

const SERIALIZE_TO_IPC_FN: "__TAURI_TO_IPC_KEY__" = '__TAURI_TO_IPC_KEY__';

Una clave que se utilizará para implementar una función especial en tus tipos que define cómo debe serializarse tu tipo al pasarse a través del IPC.

Ejemplo

Dado un tipo en Rust que luce como esto

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

UserId::String("id") se serializaría en { String: "id" } y por lo tanto necesitamos pasar la misma estructura de vuelta a 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

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L59

Funciones

addPluginListener()

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

Agrega un listener a un evento de plugin.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo
plugin	string
event	string
cb	(payload) => void

Devuelve

Promise<PluginListener>

El objeto listener para dejar de escuchar los eventos.

Desde

2.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L182

---

checkPermissions()

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

Obtiene el estado de permisos para un plugin.

Esto debe ser usado por los autores de plugins para envolver su implementación real.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo
plugin	string

Devuelve

Promise<T>

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L209

---

convertFileSrc()

function convertFileSrc(filePath, protocol): string

Convierte la ruta de archivo de un dispositivo en una URL que puede ser cargada por el webview. Ten en cuenta que asset: y http://asset.localhost deben agregarse a app.security.csp en tauri.conf.json. Ejemplo de valor CSP: "csp": "default-src 'self' ipc: http://ipc.localhost; img-src 'self' asset: http://asset.localhost" para usar el protocolo asset en fuentes de imágenes.

Además, debe agregarse "enable" : "true" a app.security.assetProtocol en tauri.conf.json y su alcance de acceso debe definirse en el arreglo scope del mismo objeto assetProtocol.

Parámetros

Parámetro	Tipo	Valor por defecto	Descripción
filePath	string	undefined	La ruta del archivo.
protocol	string	'asset'	El protocolo a utilizar. Por defecto es asset. Solo necesitas establecer esto cuando usas un protocolo personalizado.

Devuelve

string

la URL que puede usarse como fuente en el webview.

Ejemplo

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();

Desde

1.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L289

---

invoke()

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

Envía un mensaje al backend.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
cmd	string	El nombre del comando.
args	InvokeArgs	Los argumentos opcionales a pasar al comando.
options?	InvokeOptions	Las opciones de la solicitud.

Devuelve

Promise<T>

Una promesa que se resuelve o rechaza con la respuesta del backend.

Ejemplo

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

Desde

1.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L251

---

isTauri()

function isTauri(): boolean

Devuelve

boolean

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L337

---

requestPermissions()

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

Solicita permisos.

Esto debe ser usado por los autores de plugins para envolver su implementación real.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo
plugin	string

Devuelve

Promise<T>

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L218

---

transformCallback()

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

Almacena el callback en una ubicación conocida y devuelve un identificador que se puede pasar al backend. El backend utiliza el identificador para ejecutar eval() sobre el callback.

Parámetros de tipo

Parámetro de tipo	Tipo por defecto
T	unknown

Parámetros

Parámetro	Tipo	Valor por defecto
callback?	(response) => void	undefined
once?	boolean	false

Devuelve

number

Un identificador único asociado con la función de callback.

Desde

1.0.0

Fuente: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/core.ts#L69