tipets v0.3.3

tipets

Typescript-first schema declaration, validation library and contextual transformation. Inspired from io-ts and joi.

tipets is still in alpha. Expect bugs and api changes!

Features

• Typescript-first library which support type inference and schema type properly.
• Support class-based or schema-based declaration
• Powerful schema declaration, can be used to type-guard and validation. Can also be reused for multiple use case such as json, bson, or other
• Type coercion, allow data transformation from/to different type for input/output.
• Fast and Extensible, build your own schema/codec/parser

Quick Start

Install

npm install tipets

Using schema:

// create schema
const schema = object({
  id: number(),
  firstName: string(),
  lastName: optional(string()),
  active: boolean(),
})

// type-guard
if (schema.is(value)) {
  // validation
  const violations = schema.validate(value)
}

Using parser:

// create default parser
const parser = Parser.create()

// decode/encode
const decoded = parser.decode(value)
const encoded = parser.encode(decoded)

// decode without exception
const decoded = parser.tryDecode(value)
if (decoded.success) {
  // do whatever with Result
  const result = decoded.value

  // encode without exception
  const encoded = parser.tryEncode(result)
}

Built-in

Schema

*: type is still in development because I can't decide if

Parser