my-library

TypeScript-first [category] with static type inference

A lightweight, zero-dependency library that makes [problem] simple. Built with TypeScript, tree-shakeable, and fully tested.

Features

• Zero dependencies — no bloat in your node_modules
• TypeScript-first with full type inference
• Tree-shakeable ESM + CJS dual package
• Tiny bundle — under 2KB gzipped
• 100% test coverage

Installation

Prerequisites

Node.js >= 18

npm install my-library
# or
yarn add my-library
# or
pnpm add my-library

Usage

import { createSchema, validate } from 'my-library'

// Define a schema
const userSchema = createSchema({
  name: string().min(1),
  email: string().email(),
  age: number().optional(),
})

// Validate data — fully typed result
const user = validate(userSchema, data)
console.log(user.name) // TypeScript knows this is a string

API Reference

createSchema(definition)

Creates a new validation schema.

Parameter	Type	Description
definition	SchemaDefinition	Required. Object describing the shape

Returns: Schema<T> — a typed schema object

---

validate(schema, data)

Parameter	Type	Description
schema	Schema<T>	Required. Schema to validate against
data	unknown	Required. Input data

Returns: T — the validated and typed data

Throws: ValidationError with detailed error messages

Contributing

Contributions are welcome! Here’s how:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Write tests for your changes
4. Ensure all tests pass (npm test)
5. Commit your changes (git commit -m 'feat: add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

Please follow Conventional Commits for commit messages.

License

Copyright 2026 Your Name

This project is licensed under the MIT License.