TempFile SDK

Overview

The TempFile SDK creates short-lived files for caching downloads, exporting temporary content, or passing file handles across modules.

Introduction

Use TempFile when you need short-lived, namespaced files with automatic cleanup.

How it works

The main process TempFileService owns the temp directory and cleanup.
IPC channels temp-file:create / temp-file:delete handle creation and deletion.
Optional retentionMs controls cleanup schedules.

Technical Notes

Temp files live under userData/temp/<namespace>.
The SDK only wraps parameters and validates responses; file lifecycle remains in the main process.

Usage

Plugin side

import { useTempPluginFiles } from '@talex-touch/utils/plugin/sdk'

const temp = useTempPluginFiles()
const result = await temp.create({
  ext: 'svg',
  text: '<svg></svg>',
  retentionMs: 24 * 60 * 60 * 1000
})

console.log(result.url)

Renderer side

import { useTouchSDK } from '@talex-touch/utils/renderer'

const sdk = useTouchSDK()
const result = await sdk.createTempFile({
  namespace: 'icons/svg',
  ext: 'svg',
  text: '<svg></svg>',
  retentionMs: 7 * 24 * 60 * 60 * 1000
})

Examples

Download remote SVGs into temp files and serve them via tfile://.
Export debug logs into a temp file and open it locally.

FAQ

Q: Are temp files cleaned automatically?
A: Yes. When retentionMs is provided, the main process periodically removes expired files.

Q: Why does tfile:// not load?
A: tfile:// is Electron-only; browsers will block it.

Q: Why does tfile:// still return 403 in Electron?
A: Access is restricted to approved roots (home/userData/temp and system app directories). Use the temp-file API or move assets into allowed roots.

Best Practices

Use clear namespace values to simplify cleanup and debugging.
Set a reasonable retentionMs to prevent temp bloat.
Prefer file paths for large payloads instead of embedding big text blobs.