API reference
Types
Request, event and result types of tauri-plugin-keyring-store-api, generated from guest-js/index.ts.
Every interface and type alias tauri-plugin-keyring-store-api exports, generated from
guest-js/index.ts. Request types are sent to the commands
as is (camelCase); event payload types describe what the backend emits.
Interfaces
Duration
Duration hint (ignored for OS keyring persistence; kept for Stronghold API compatibility).
| Property | Type | Description |
|---|---|---|
secs | number | |
nanos | number |
PasswordEntryDto
Bulk / direct account IPC DTO (matches Rust PasswordEntryDto).
| Property | Type | Description |
|---|---|---|
account | string | |
secret | string |
PasswordBackupEntryDto
| Property | Type | Description |
|---|---|---|
account | string | |
secret? | string | null |
PasswordBackupPlainDto
| Property | Type | Description |
|---|---|---|
formatVersion | number | |
entries | PasswordBackupEntryDto[] |
PasswordBackupEncryptedDto
| Property | Type | Description |
|---|---|---|
formatVersion | number | |
salt | string | |
nonce | string | |
ciphertext | string |
Type aliases
ClientPath
Client name: text, or bytes (Uint8Array, ArrayBuffer, number[]). A byte id equal to the UTF-8 of a text id is the same client.
type ClientPath =
| string
| Iterable<number>
| ArrayLike<number>
| ArrayBuffer
VaultPath
Vault name: text or bytes, like ClientPath.
type VaultPath =
| string
| Iterable<number>
| ArrayLike<number>
| ArrayBuffer
RecordPath
Vault record name: text or bytes, like ClientPath.
type RecordPath =
| string
| Iterable<number>
| ArrayLike<number>
| ArrayBuffer
StoreKey
Store record key: text or bytes; a byte key addresses the same record as the equal UTF-8 text key.
type StoreKey =
| string
| Iterable<number>
| ArrayLike<number>
| ArrayBuffer
Bytes
Bytes accepted for record values and secrets.
type Bytes = number[] | Uint8Array