typia

Typia

// RUNTIME VALIDATORS
export function is<T>(input: unknown): input is T; // returns boolean
export function assert<T>(input: unknown): T; // throws TypeGuardError
export function assertGuard<T>(input: unknown): asserts input is T;
export function validate<T>(input: unknown): IValidation<T>; // detailed

// JSON FUNCTIONS
export namespace json {
  export function schema<T>(): IJsonSchemaUnit<T>; // JSON schema
  export function assertParse<T>(input: string): T; // type safe parser
  export function assertStringify<T>(input: T): string; // safe and faster
}

// AI FUNCTION CALLING SCHEMA
export namespace llm {
  // collection of function calling schemas
  export function application<Class>(): ILlmApplication<Class>;
  export function controller<Class>(
    name: string,
    execute: Class,
  ): ILlmController; // +executor
  // structured output
  export function parameters<P>(): ILlmSchema.IParameters;
  export function schema<T>(
    $defs: Record<string, ILlmSchema>,
  ): ILlmSchema; // type schema
}

// PROTOCOL BUFFER
export namespace protobuf {
  export function message<T>(): string; // Protocol Buffer message
  export function assertDecode<T>(buffer: Uint8Array): T; // safe decoder
  export function assertEncode<T>(input: T): Uint8Array; // safe encoder
}

// RANDOM GENERATOR
export function random<T>(g?: Partial<IRandomGenerator>): T;

typia is a transformer library supporting below features:

• Super-fast Runtime Validators
• Enhanced JSON schema and serde functions
• LLM function calling schema and structured output
• Protocol Buffer encoder and decoder
• Random data generator

[!NOTE]

• Only one line required, with pure TypeScript type
• Runtime validator is 20,000x faster than class-validator
• JSON serialization is 200x faster than class-transformer

Transformation

If you call typia function, it would be compiled like below.

This is the key concept of typia, transforming TypeScript type to a runtime function. The typia.is<T>() function is transformed to a dedicated type checker by analyzing the target type T in the compilation level.

This feature enables developers to ensure type safety in their applications, leveraging TypeScript's static typing while also providing runtime validation. Instead of defining additional schemas, you can simply utilize the pure TypeScript type itself.

//----
// examples/checkString.ts
//----
import typia, { tags } from "typia";
export const checkString = typia.createIs<string>();

//----
// examples/checkString.js
//----
import typia from "typia";
export const checkString = (() => {
  return (input) => "string" === typeof input;
})();

Sponsors

Thanks for your support.

Your donation encourages typia development.

Also, typia is re-distributing half of donations to core contributors of typia.

• nonara/ts-patch
• ryoppippi/unplugin-typia

Playground

You can experience how typia works by playground website:

• 💻 https://typia.io/playground

Guide Documents

Check out the document in the website:

🏠 Home

• Introduction
• Setup
• Pure TypeScript

📖 Features

• Runtime Validators
  • assert() function
  • is() function
  • validate() function
  • Functional Module
  • Special Tags
• Enhanced JSON
  • JSON Schema
  • stringify() functions
  • parse() functions
• LLM Function Calling
  • application() function
  • parameters() function
  • schema() function
  • AI Chatbot Development
  • Documentation Strategy
• Protocol Buffer
  • Message Schema
  • decode() functions
  • encode() functions
• Random Generator
• Miscellaneous

🔗 Appendix

• API Documents
• Utilization Cases
  • NestJS
  • tRPC
• ⇲ Benchmark Result
• ⇲ dev.to Articles

References

• inspired by typescript-is
• inspired by ts-patch

Similar packages

Other packages similar to typia

io-ts

io-ts is a runtime type system for IO decoding/encoding in TypeScript. It provides similar functionality to typia in terms of runtime type checking and validation. However, io-ts uses a functional programming approach and is more focused on decoding and encoding data.

zod

Zod is a TypeScript-first schema declaration and validation library. It offers similar validation and type-checking capabilities as typia but with a more declarative API for defining schemas. Zod is known for its simplicity and ease of use.

class-validator

Class-validator is a library for validating TypeScript class objects. It provides decorators for defining validation rules directly in class definitions. While it focuses on class-based validation, typia offers a broader range of type-related utilities.