Skip to content

JTCSV Documentation

Current version: 3.1.0

Welcome to the JTCSV docs hub. Start here, then dive into the topic pages.

Getting started

  • ../README.md - project overview and quick start.
  • GETTING_STARTED.md - 5-minute quick start with common examples.
  • API_DECISION_TREE.md - pick the right CSV/JSON API.
  • API_CANONICALIZATION.md - canonical names and alias mapping.

Core usage

  • HOWTO.md - usage snippets and examples.
  • recipes/index.md - practical recipes and workflows.
  • STREAMING_GUIDE.md - streaming, iterators, and memory guidance.
  • ERRORS.md - error codes and recovery.
  • TROUBLESHOOTING.md - common errors and fixes.
  • SCHEMA_VALIDATOR.md - schema format and usage (jtcsv/schema).

Interfaces

  • CLI.md - command line interface.
  • BROWSER.md - browser API (UMD/ESM, workers).
  • PLUGINS.md - plugin system overview.
  • PLUGIN_AUTHORING.md - author custom plugins.

Integrations

  • integrations/index.md - framework integration hub.
  • integrations/express.md - Express upload API.
  • integrations/fastify.md - Fastify upload API.
  • integrations/react-hook-form.md - React Hook Form uploader.
  • integrations/nextjs-app-router.md - Next.js App Router upload.
  • integrations/drizzle-orm.md - Drizzle ORM import.
  • integrations/graphql.md - GraphQL upload.

Performance & security

  • PERFORMANCE.md - benchmarks and optimizations.
  • BENCHMARKS.md - public benchmark artifacts and comparisons.
  • ../SECURITY.md - security notes and OWASP checklist.

Reference

  • README_ALL_DOCS.md - full documentation index.
  • TUI-README.md - terminal UI notes.

Released under the MIT License.