Typescript Generator
A TypeScript interface generator for PocketBase collections, available as a standalone CLI tool or Go library with auto-generation hooks.
Overview
pocketbase-ts-generator is a tool that automatically generates TypeScript interfaces from PocketBase collections, ensuring type safety and reducing manual work in frontend development. It can be used as a standalone CLI application or integrated directly into PocketBase projects as a Go library with hooks for automatic regeneration.
Key Features
- Standalone CLI — Run as an executable to connect to any PocketBase server and generate TypeScript definitions via prompts or command-line flags.
- Go Library Integration — Embed the generator within your PocketBase project as a custom command or hook.
- Automatic Regeneration — Use hooks to automatically update TypeScript files whenever collections are created, updated, or deleted.
- Flexible Collection Selection — Choose specific collections to include or exclude, with options to handle system collections.
- Credential Management — Save credentials in plain or encrypted files for streamlined repeated use.
- Output Customization — Generate definitions to a file or print to console, with optional non-required fields marked as optional.
Philosophy
The project emphasizes automation and integration, reducing the friction of maintaining type definitions between PocketBase backends and TypeScript frontends by providing both standalone and embedded solutions.
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
