runtypes

What's Changed

• docs: add description about InstanceOf runtype by @yuhr in https://github.com/pelotom/runtypes/pull/313
• chore(docs): update from cobraz to simenandre by @simenandre in https://github.com/pelotom/runtypes/pull/324
• Allow for multiple brands by @cedw032 in https://github.com/pelotom/runtypes/pull/329

New Contributors

• @simenandre made their first contribution in https://github.com/pelotom/runtypes/pull/324
• @cedw032 made their first contribution in https://github.com/pelotom/runtypes/pull/329

Full Changelog: https://github.com/pelotom/runtypes/compare/v6.6.0...v6.7.0

What's Changed

• Bump minimist from 1.2.5 to 1.2.6 by @dependabot in https://github.com/pelotom/runtypes/pull/303
• fix: correct spelling for 'required' in brand example by @patrickocoffeyo in https://github.com/pelotom/runtypes/pull/302
• chore: configure Corepack by @yuhr in https://github.com/pelotom/runtypes/pull/304
• Verbose validation error message by @HzrdIRL in https://github.com/pelotom/runtypes/pull/296
• docs: add section about error information by @yuhr in https://github.com/pelotom/runtypes/pull/309

New Contributors

• @patrickocoffeyo made their first contribution in https://github.com/pelotom/runtypes/pull/302
• @HzrdIRL made their first contribution in https://github.com/pelotom/runtypes/pull/296

Full Changelog: https://github.com/pelotom/runtypes/compare/v6.5.1...v6.6.0

What's Changed

• Bump ansi-regex from 5.0.0 to 5.0.1 by @dependabot in https://github.com/pelotom/runtypes/pull/287
• Upgrade typescript to 4.4.4 by @yuhr in https://github.com/pelotom/runtypes/pull/288
• Upgrade typescript to 4.5.2 by @yuhr in https://github.com/pelotom/runtypes/pull/291
• Setup workflow for testing by @yuhr in https://github.com/pelotom/runtypes/pull/292
• fixed template number regexp by @iyegoroff in https://github.com/pelotom/runtypes/pull/298
• Add related library in README. by @codemariner in https://github.com/pelotom/runtypes/pull/297

New Contributors

• @iyegoroff made their first contribution in https://github.com/pelotom/runtypes/pull/298
• @codemariner made their first contribution in https://github.com/pelotom/runtypes/pull/297

Full Changelog: https://github.com/pelotom/runtypes/compare/v6.5.0...v6.5.1

What's Changed

• Add helper function when for top-level match function by @yuhr in https://github.com/pelotom/runtypes/pull/285
• Bump tmpl from 1.0.4 to 1.0.5 by @dependabot in https://github.com/pelotom/runtypes/pull/286

Full Changelog: https://github.com/pelotom/runtypes/compare/v6.4.1...v6.5.0

Bug Fixes

• Enable static types of Optional in Dictionary (#281)
• Fix return type of top-level match function (#283)

Features

• Add Template runtype (#279)

Bug Fixes

• Use globalThis instead of global (#273)

Documentation

• Add runtyping as a related library (#271)

Bug Fixes

• Handle null prototypes in failure messaging (#263)

Refactors

• Unuse unicode option for regex (#245)

Documentation

• Add more related libraries (#242)

Features

• Add extend helper function to Record (#239)
• Add predefined Nullish runtype (#241)

Reverts

• Revert "Remove workaround for resolved TypeScript issue (#230)" (#233)

Features

• Introduce Record .pick and .omit (#161)

Bug Fixes

• Handle objects with null prototypes (#227)

Refactors

• Remove workaround for resolved TypeScript issue (#230)
• Use any for internal type assertion (#231)

Features

• Add nullable shorthand (#226)

Refactors

• Unuse Exclude internally in static type of Record (#223)
• Widen type parameter boundary to RuntypeBase (#225)

Features

• Support arbitrary length intersections (#165)
• Support arbitrary length tuples (#168)
• Support arbitrary length unions (#166)
• Support arbitrary length contracts (#202)
• Support arbitrary length async contracts (#203)
• Support symbol-keyed properties of object validation (#204)
• Provide descriptive error messages (#209)

Bug Fixes

• Add null check into hasKey utility (#205)
• Add missing readonly to Union function (#208)

BREAKING CHANGES

• the various Intersect2, Intersect3, ... types have all been replaced with a single Intersect type that takes a tuple of Runtype validators.
• the various Tuple2, Tuple3, ... types have all been replaced with a single Tuple type that takes a tuple of Runtype validators.
• the various Union2, Union3, ... types have all been replaced with a single Union type that takes a tuple of Runtype validators.
• the various Contract2, Contract3, ... types have all been replaced with a single Contract type that takes a tuple of Runtype meaning parameters and a Runtype meaning a return type
• the various AsyncContract2, AsyncContract3, ... types have all been replaced with a single AsyncContract type that takes a tuple of Runtype meaning parameters and a Runtype meaning a return type of Promise.
• Dictionary now does not look over non-enumerable properties of tested objects, and Record now does not recognize inherited properties of passed schema

• Branded types now compatible with declaration option of TS (#196)
• Remove unnecessary files from packaging result
• Add Optional runtype (#113)
• Support symbol key validation (#200)

• Add BigInt runtype (#185)
• Add support for generic dictionary key (#193)

• Docs for branded types (#112)
• Adds TypeScript 4.2 compatibility
• Use export type (#177)

• Fix missing export (#157)

• Add .asReadonly() for Record and Partial (#153)

BREAKING CHANGE:

This refactors Partial to be just a special case of Record, so it is no longer its own distinct runtype which has to be handled in case analysis of the Reflect type.

• Fix ValidationError message bug (#134)
• Fix some code examples in the readme (#140)
• Update Type guards URL reference (#150)
• Implement Discriminated Unions (#149)

Add AsyncContract (#122)
Add cycle breaking sets to InternalRecord (#123)
Add tuple 0 and make length check exact. (#124)
Add assert to Runtype. Added typecheck script. (#125)
Add documentation for readonly records and arrays (#126)