# Stof

> Data that carries its own logic

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [About These Docs](https://stof.dev/docs/start/about.md): A short map of this site and how the runnable examples work.
- [How Stof Works](https://stof.dev/docs/start/how-it-works.md): How does Stof work?
- [Install](https://stof.dev/docs/start/install.md): Install Stof for your language of choice — CLI, TypeScript, Python, or Rust.
- [Stof Mission](https://stof.dev/docs/start/mission.md): Why does Stof exist and where is it going?
- [Quick Start](https://stof.dev/docs/start/quickstart.md): Get started with Stof in 5 minutes.
- [Async](https://stof.dev/docs/learn/async.md): The process model, async expressions and blocks, awaiting multiple processes, and promise types.
- [Attributes](https://stof.dev/docs/learn/attributes.md): The
- [Collections](https://stof.dev/docs/learn/collections.md): Working with lists, maps, sets, and tuples — the operations Types & Units deferred to this page.
- [Control Flow](https://stof.dev/docs/learn/control-flow.md): if/else, switch, while, loop, for, tagged break/continue, and try/catch.
- [The Document Graph](https://stof.dev/docs/learn/document-graph.md): How a Stof document is actually structured — nodes, data components, and how to navigate between them.
- [Error Handling](https://stof.dev/docs/learn/error-handling.md): Throwing and catching rich values, propagation, rethrowing, and how this differs from the ??/? operators.
- [Fields](https://stof.dev/docs/learn/fields.md): How Stof stores data — declaration styles, casting, immutability, visibility, and nullability.
- [Formats](https://stof.dev/docs/learn/formats.md): Every format identifier usable with parse, stringify, blobify, and import — what each one does and what field names it lands on.
- [Functions](https://stof.dev/docs/learn/functions.md): Declaring and returning, optional and named parameters, arrow functions, functions as fields, and recursion.
- [Import & Export](https://stof.dev/docs/learn/import-and-export.md): Exporting with stringify and blobify, parsing at runtime, and the import statement's syntax, paths, and formats.
- [Document Memory Management](https://stof.dev/docs/learn/memory-management.md): drop(), the shallow option on Obj.remove(), and the arena pattern for cleaning up objects created programmatically.
- [Null & Initialization](https://stof.dev/docs/learn/null-and-init.md): Not-null types, the ?? and ? operators, ternaries, and block expressions for handling null cleanly.
- [Object Run](https://stof.dev/docs/learn/object-run.md): self.run() — executing every #[run]-tagged function and field on an object, in order, as a workflow.
- [Prototypes & Schemas](https://stof.dev/docs/learn/prototypes-and-schemas.md): Named object templates with
- [Testing](https://stof.dev/docs/learn/testing.md): #[test] functions, the assert family, expected-failure tests with #[errors], and the stof test CLI command.
- [Types & Units](https://stof.dev/docs/learn/types-and-units.md): Scalar, obj, fn, compound, unit, semver, and data types — plus casting and unknown/union types.
- [Units Reference](https://stof.dev/docs/learn/units-reference.md): Every unit Stof supports, by category — abbreviation and full name both work anywhere a unit is expected.
- [Variables & References](https://stof.dev/docs/learn/variables-and-references.md): let and const, scoping, and the value-type vs reference-type distinction that governs how data gets copied.
- [Age Encryption (Age)](https://stof.dev/docs/libs/age-library.md): Public-key and passphrase encryption for parts of a document — generate identities, encrypt to a recipient, and decrypt with the matching key.
- [File System Library (fs)](https://stof.dev/docs/libs/file-system-library.md): Reading and writing files from disk. Requires the "system" feature — CLI and native hosts only, not available in this browser sandbox.
- [HTTP Network Library (Http)](https://stof.dev/docs/libs/http-library.md): Making HTTP requests and reading responses. Requires the "http" feature — not loaded in this browser sandbox, so examples here are reference only.
- [Image Library (Image)](https://stof.dev/docs/libs/image-library.md): Loading, transforming, resizing, and exporting images via the Data<Image> type. Requires the "image" feature — CLI only, not available in this brow...
- [Markdown Library (Md)](https://stof.dev/docs/libs/markdown-library.md): Converting Markdown strings to HTML or a structured JSON representation.
- [PDF Library (Pdf)](https://stof.dev/docs/libs/pdf-library.md): Extracting text and images from PDF files via the Data<Pdf> type. Requires the "pdf" feature — not available in this browser sandbox.
- [Standard Library (Std)](https://stof.dev/docs/libs/standard-library.md): Every Std function — printing, assertions, parsing/exporting, collections, introspection, and process control. Implied by default; Std.pln(...) and...
- [Time Library (Time)](https://stof.dev/docs/libs/time-library.md): Timestamps, RFC-2822/3339 formatting, calendar arithmetic, and period boundaries — all working in plain millisecond units.
- [A Self-Assembling AI Context](https://stof.dev/docs/cookbook/ai-context.md): An agent whose prompt is built by reading its own tools and memory — add a capability and the context updates itself, nothing to keep in sync by hand.
- [A Scoped, Expiring Auth Context](https://stof.dev/docs/cookbook/auth-context.md): A temporary share link that knows when it expires and refuses to decrypt its payload once it has — no database row, no server-side check.
- [A Self-Validating Config](https://stof.dev/docs/cookbook/config.md): A plan config that rejects an invalid reset interval before it ever reaches billing logic — schema validation as part of the data itself.
- [Fetch, Validate, and Cache an API Response](https://stof.dev/docs/cookbook/fetch-validate-cache.md): A response cache that validates what comes back and only refetches once it's actually stale — one object, not three separate systems.
- [A Sandboxed Plugin System](https://stof.dev/docs/cookbook/plugins.md): Untrusted plugin code that can transform the data it's handed, but can't reach a filesystem or network it was never given — safely, by construction.
- [Unifying Config from Multiple Formats](https://stof.dev/docs/cookbook/unify-formats.md): A YAML manifest, a TOML config, and a JSON response — parsed into one graph and read the exact same way, no per-format branching.
- [Blob Library (Blob)](https://stof.dev/docs/libs/types/blob-library.md): Working with raw binary data — byte access, size, and Base64/UTF-8 encoding.
- [Data Library (Data)](https://stof.dev/docs/libs/types/data-library.md): Low-level access to the opaque Data handles underneath every field and function.
- [Function Library (Fn)](https://stof.dev/docs/libs/types/function-library.md): Calling, binding, and introspecting functions as first-class values.
- [List Library (List)](https://stof.dev/docs/libs/types/list-library.md): Query, access, modify, remove, sort, and convert operations on the list type.
- [Map Library (Map)](https://stof.dev/docs/libs/types/map-library.md): Query, access, and modify operations on the map type. Maps are ordered by key.
- [Number Library (Num)](https://stof.dev/docs/libs/types/number-library.md): Rounding, trigonometry, logarithms, base representations, and unit inspection — automatically linked to int, float, and every unit type.
- [Object Library (Obj)](https://stof.dev/docs/libs/types/object-library.md): Every Obj function — navigation, fields and data, prototypes, and structural operations on the obj type.
- [Prompt Library (Prompt)](https://stof.dev/docs/libs/types/prompt-library.md): Building and reading a prompt value — a small tree of tagged text meant for AI-workflow contexts.
- [Set Library (Set)](https://stof.dev/docs/libs/types/set-library.md): Query, modify, and set-algebra operations (union, intersection, difference) on the set type.
- [String Library (Str)](https://stof.dev/docs/libs/types/string-library.md): Query, access, case/whitespace, modification, and regex operations on the str type.
- [Tuple Library (Tup)](https://stof.dev/docs/libs/types/tuple-library.md): Indexed access into a fixed-length tuple.
- [Semantic Version Library (Ver)](https://stof.dev/docs/libs/types/ver-library.md): Reading and modifying the major, minor, patch, release, and build portions of a ver value.