Skip to content

documentsDir ​

documentsDir returns the user's documents directory.

SignaturedocumentsDir(): string?
tyrus
import { documentsDir } from "tyrus:os";

const documents: string? = documentsDir();
if (documents) {
    print(`documents: ${documents}`);
}

Absence is a valid outcome

A headless system (a server, a container, CI) commonly has no documents directory at all, that is a normal result, not a failure.