Meet Jane¶
Clarity‑first data boundaries for real‑world TypeScript systems.
Jane is a data boundary framework built for developers who want predictable, transparent, and teachable input handling. It gives you a complete, multi‑stage pipeline for turning raw input into meaningful, validated values — with full visibility into every step.
Where most libraries blur parsing, coercion, validation, and decision‑making into a single opaque step, Jane separates each stage with intention. The result is a system that’s easier to reason about, easier to debug, and easier to teach to new contributors.
Jane is built for teams who care about correctness, clarity, and long‑term maintainability.
Getting Started¶
Learn the basics and build your first pipeline
If you’re new to Jane, start here.
This section walks you through the core ideas and gets you productive quickly — no assumptions, no jargon, no magic.
You’ll learn:
- How to install Jane.
- How pipelines work.
- How parsing and validation fit together.
- How to read results.
- How to choose the right mode.
- How to validate entire objects with boundaries.
- How to enable analysis features.
- How to tune behavior with policy.
This is the fastest way to understand Jane’s mental model and start using it in real applications.
Concepts¶
The architecture and philosophy behind Jane.
Concepts explain why Jane works the way it does. These pages go deeper than the Getting Started guide and give you the mental models you need to use Jane confidently in large systems.
You’ll explore:
- Scan — structural safety.
- Normalization — structural hygiene.
- Parsing — interpreting meaning.
- Validation — enforcing rules.
- Policy — interpreting events and making decisions.
- Boundaries — validating entire objects.
- JaneResult — the structured output of every run.
- Diff, Explain, Replay, Telemetry — Jane’s analysis layer.
Each concept page is narrative, rationale‑rich, and focused on clarity.
Perfect for onboarding new contributors or deepening your own understanding.
Reference¶
Every public API, documented clearly and consistently.
The Reference section is your source of truth for Jane’s public surface. Every function, parser, validator, boundary helper, and policy option is documented with:
- Clear descriptions.
- Signatures.
- Parameter tables.
- Return shapes.
- Examples.
- Design rationale.
Reference pages are intentionally predictable and minimal — perfect for quick lookup when you already understand the concepts and need exact details.
Support¶
Troubleshooting, FAQs, and guidance for real teams.
The Support section helps you solve problems quickly and understand how to use Jane effectively in your environment.
You’ll find:
- Common error explanations.
- Debugging guides.
- How to interpret events and issues.
- How to use analysis features for troubleshooting.
- Best practices for boundaries and pipelines.
- Guidance for large teams and long‑term maintainability.
If something isn’t working or you’re unsure how to approach a problem, start here.
Why Jane?¶
Jane is built for developers who want:
- Predictable behavior.
- Explicit pipelines.
- Transparent decisions.
- Structured events.
- Audit‑ready analysis.
- Clean, teachable architecture.
- Zero magic, zero guessing.
Jane doesn’t try to be clever. Jane tries to be clear.
It gives you the tools to build safe, maintainable, and transparent data boundaries — the kind of systems that scale with teams, survive audits, and remain understandable years later.