Skip to main content

Import

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

Examples

File operations

import { readTextFile, writeTextFile, mkdir, exists } 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"

Exports

Functions

NameDescription
basenameGet filename of path
createFileSystemCreate platform-agnostic FS
cwdGet project root
dirnameGet directory of path
existsCheck path exists
extnameGet file extension
joinJoin path segments
mkdirCreate directory (recursive supported)
readDirList directory entries
readTextFileRead file as UTF-8
removeDelete file or directory
resolveResolve to absolute path
writeTextFileWrite UTF-8 to file

Types

NameDescription
FileSystemFilesystem interface