@hunterstack/typebox-helpers
v0.0.5TypeScript
Tree shakable typebox helper utilities
0/weekUpdated 4 months agoMITUnpacked: 10.6 KB
Published by Hunter Wilhelm
npm install @hunterstack/typebox-helpers
TypeBox Helpers
A collection of tree-shakable TypeBox helper utilities to make working with TypeBox even easier.
Installation
``bash`
npm install @hunterstack/typebox-helpers
Features
- Tree-shakable utilities
- Type-safe helpers
- Zero dependencies (except TypeBox)
Usage
$3
Create TypeBox union types from any literal values (strings, numbers, booleans) with full type safety:
`typescript
import { UnionOf } from '@hunterstack/typebox-helpers'
const Status = UnionOf(['active', 'inactive', 'pending'])
// TUnion<[TLiteral<"active">, TLiteral<"inactive">, TLiteral<"pending">]>
const Numbers = UnionOf([1, 2, 3, 4, 5])
// TUnion<[TLiteral<1>, TLiteral<2>, TLiteral<3>, TLiteral<4>, TLiteral<5>]>
const Mixed = UnionOf([1, 'red', true])
// TUnion<[TLiteral<1>, TLiteral<"red">, TLiteral
`
Testing
This package is thoroughly tested with a comprehensive approach:
$3
- Vitest for runtime validation testing
- Tests ensure schemas correctly validate expected values and reject invalid ones
- Integration tests with frameworks like Elysia
- Covers all literal types: strings, numbers, booleans, and mixed unions
$3
- @ark/attest for type inference checking performance
- Ensures TypeScript types are correctly inferred
- Validates that generated schemas match expected TypeBox types
- Prevents type regressions and ensures full type safety
$3
- Performance benchmarks using @ark/attest
- Monitors schema creation and validation performance
- Automated performance regression detection
`bashRun all tests
npm test
Run tests in watch mode
npm run test:watch
Run benchmarks
npm run bench
`
Development
bash
Install dependencies
npm installRun tests
npm testRun benchmarks
npm run benchBuild
npm run build
``License
MIT