justinyaodu/caketype

Delicious runtime type-checking

caketype's Issues

Add `Cake.withOptions` method

Consistent usage of _method_, etc. in README

Strict checking of object and array prototypes

Add `.opaque()` method on Cakes

Return itself cast to an OpaqueCake type, which lacks as, is, and similar methods. This ensures that a Cake cannot be used without an explicitly constructed Checker, which can prevent mistakes if a specific Checker should always be used for a type. (For example, a circular linked list can only be validated if circular references are handled unsoundly.)

Allow any Cake to have an explicitly set name

Test `reference` type parameters

Make `omit` infer optional properties if object key is a subtype of omitted key

omit({ a: 1, b: 2 } as const, Math.random() < 0.5 ? "a" : "b") should have an inferred type of { a?: 1, b?: 2 }.

Add docs for `Cake.withName`

Make `markdown-toc.js` only output API Reference TOC

Add docs for Cake subclasses and introspection

Fix prototype pollution in object utilities

Add `UnionCake`

Add docs for `ReferenceCake` and tips for working with circular Cakes

Update topics, keywords, etc. on GitHub and in package.json

Make `number` reject `NaN`

Allowing NaN is rarely the desired behavior, due to its odd behavior with comparisons and tendency to propagate. Add a separate numberOrNaN Cake to allow NaNs.

Add more thorough tests for `lookup`

Varying numbers of objects, symbol keys, type inference with optional properties.

Add `IntersectionCake`

Add docs for `typeGuard`

Add `lookup` object utility

Given a key and multiple objects (or nullish values), find the first object which has a non-undefined value for that key, and return the value. If no value is found, return undefined.

Add docs for `bake(null)` and `bake(undefined)`

Add `tuple` helper for constructing TupleCakes

Test variance of `Result`

Test variance of `Refinement`

Add refinements

Add more instance methods to `Result`s

Add introduction and user guide to README

Add `integer` Cake

Test `: Cake<...>` type annotation for type equivalence

Make `Merged` internal and rename it for consistency with `LookupReturn`

Modify `Cake.toString` to assume that nested types are properly parenthesized

This should reduce the number of redundant parentheses without adding any complexity to the implementation.

Add horizontal rules in changelog

Add usage examples for object utilities

Add `TupleCake`

Add `LiteralCake`

Add docs for CakeError subclasses

Add `InstanceCake`

Add `check` example to user guide

Add a `strictOptional` tag

Like a runtime equivalent of --exactOptionalPropertyTypes: an optional property that cannot be set to undefined.

Add options to customize runtime type-checking behavior

`merge` should accept and ignore null and undefined arguments

For consistency with Object.assign.

Add docs for implementing custom Cakes