Skip to main content

Documentation Index

Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

veryfront/fs

Public filesystem, path, and cwd utilities.

Import

import {
  readTextFile,
  writeTextFile,
  join,
  resolve,
  exists,
  mkdir,
} from "veryfront/fs";

Examples

File operations

import { exists, mkdir, readTextFile, writeTextFile } from "veryfront/fs";

const content = await readTextFile("./data/config.json");
await writeTextFile("./output/result.json", JSON.stringify(data));
await mkdir("./output", { recursive: true });

Path utilities

import { join, resolve, dirname, basename, extname } from "veryfront/fs";

const filePath = join("src", "pages", "index.tsx");
const dir = dirname(filePath); // "src/pages"

Working directory

import { cwd, resolve } from "veryfront/fs";

const configPath = resolve(cwd(), "veryfront.config.ts");

Exports

Functions

NameDescriptionSource
basenameReturn the last path segment.source
createFileSystemCreate file system.source
cwdReturn the current working directory.source
dirnameReturn the parent directory path.source
existsCheck whether a path exists.source
extnameReturn the file extension for a path.source
joinJoin path segments.source
mkdirCreate a directory.source
readDirRead directory entries.source
readTextFileRead a file as text.source
removeRemove a file or directory.source
resolveResolve path segments to an absolute path.source
writeTextFileWrite text to a file.source

Types

NameDescriptionSource
FileSystemPublic API contract for file system.source
Reference modules: