agent-kit
API reference

@rivus/agent-kit/platform

Platform (type only) — anywhere

Interfaces

FileStat

Properties

identity?
readonly identity?: FileIdentity;

The file's identity, when the platform knows one; a use case that must tell a replacement from the file it saw reads it.

kind
readonly kind: FileKind;
mtimeMs
readonly mtimeMs: number;
size
readonly size: number;

Platform

Host capabilities injected into use cases. A use case declares only the part it needs, for example Pick<Platform, "fs" | "env" | "home">.

Properties

clock
readonly clock: PlatformClock;
decompress?
readonly decompress?: Decompress;

Present when the host can decode a compressed session source; absent otherwise.

env
readonly env: Env;
fs
readonly fs: PlatformFs;
home
readonly home: string;
os
readonly os: OperatingSystem;
process
readonly process: PlatformProcess;
sqlite?
readonly sqlite?: PlatformSqlite;