Files
plainleaf/plug-api/syscalls/sync.ts
T
Zef Hemel a321339e9a Fixes #1495
Renames sync.* syscalls to be more accurate, specifically that this is not about scheduling a sync but actually performing the sync.
2025-08-20 10:58:30 +02:00

36 lines
853 B
TypeScript

import { syscall } from "../syscall.ts";
/**
* Syscalls that interact with the sync engine (when the client runs in Sync mode)
* @module
*/
/**
* Checks if a sync is currently in progress
*/
export function isSyncing(): Promise<boolean> {
return syscall("sync.isSyncing");
}
/**
* Checks if an initial sync has completed
*/
export function hasInitialSyncCompleted(): Promise<boolean> {
return syscall("sync.hasInitialSyncCompleted");
}
/**
* Syncs a file immediately. Sync would happen automatically, but this prioritizes the file.
* @param path the path to the file to sync
*/
export function performFileSync(path: string): Promise<void> {
return syscall("sync.performFileSync", path);
}
/**
* Performs an immediate full sync.
*/
export function performSpaceSync(): Promise<number> {
return syscall("sync.performSpaceSync");
}