Documentation

HomeBAMLCLICloudTutorialsExamples

BAML documentation

  • Overview
  • Get started
  • Book
    • 8. Handle errors
    • 11. Interfaces
    • 12. Run work concurrently
  • Language reference
    • Functions
  • Standard packages
  • Language bridges
    • TypeScript

Products

  • BAML CLI
  • Cloud

Resources

  • Tutorials
    • Structured extraction
  • Examples
    • Classify support tickets
    • Images and vision models
HomeBAMLCLICloudTutorialsExamples
Start

Sections

  • Overview
  • Get started
  • Book
    • 8. Handle errors
    • 11. Interfaces
    • 12. Run work concurrently
  • Language reference
    • Functions
  • Standard packages
  • Language bridges
    • TypeScript

Products

  • BAML CLI
  • Cloud

Resources

  • Tutorials
    • Structured extraction
  • Examples
    • Classify support tickets
    • Images and vision models
BAMLStandard packagesv0.20.0bamlfsread_dir

baml.fs.read_dir

Returns an array of directory entries for the directory at `path`.

Reference version

Signature

function baml.fs.read_dir(path: string) -> baml.fs.DirEntry[] throws baml.errors.Io

Returns an array of directory entries for the directory at path.

Source:<builtin>/baml/ns_fs/fs.bamlbytes 5480–5573

Related definitions

  • baml.Array
  • baml.errors.Io
  • baml.fs.DirEntry
  • baml.String

On this page

  • Signature
  • Related definitions

Build with BAML

Start with the language guide and a checked BAML function.

Continue into generated package and CLI references for the exact selected toolchain.

Get started
Developer documentation for BAML and Boundary products. Source available on GitHub. View release notes