Skip to content

Latest commit

 

History

History
148 lines (108 loc) · 7.07 KB

Readme.md

File metadata and controls

148 lines (108 loc) · 7.07 KB
Raw

@appliedblockchain/tsql esm cjs

Summary

Functional assertion combinators.

Name Type Runtime
Primitive string $.string
Primitive number $.number
Primitive boolean $.boolean
Primitive undefined $.undefined
Primitive null $.null
Undefined or null undefined | null $.nil
Undefined or A undefined | A $.undefinedOr(a)
Nullable A null | A $.nullOr(a)
Nillable A undefined | null | A $.nilOr(a)
Unknown unknown $.unknown
Array A[] $.array(a)
Object { a: A, b: B } $.object({ a, b })
Exact object { a: A, b: B } $.exact({ a, b })
Record Record<K, V> $.record(k, v)
Keyed object Record<string, undefined | V> $.keyed(v)
Intersection A & B $.and(a, b)
Primitive type union 'A' | 'B' $.oneOf('A', 'B')
Union A | B $.or(a, b)
Date string YYYY-MM-DD stringweaker $.dateString
Defined Exclude<A, undefined> $.defined(a)
Literal primitive "foo", 42 $.eq('foo'), $.eq(42)
Tuple [number, string] $.tuple($.number, $.string)
Finite number numberweaker $.finite
Positive number numberweaker $.positive
Safe integer numberweaker $.safeInteger
Greater than numberweaker $.gt(42)
Greater than numberweaker $.gt(42)
Greater or equal than numberweaker $.gte(42)
Non blank string stringweaker $.nonBlankString
Regexp stringweaker $.regexp(/^[a-z]+$/i)
Strftime formatted string stringweaker $.strftime('%Y-%m-%d')

Utility functions

  • errorOf – instead of throwing, returns Error or undefined if assertion passes.
  • identity
  • if
  • implies
  • in
  • predicate
  • rethrow

Examples

import * as $ from '@appliedblockchain/assert-combinators'

ws.on('message', _ => {

  const { method, agree } = $.object({
    method: $.string,
    agree: $.boolean
  })(JSON.parse(_))

  // Types are correct:
  // method: string
  // agree: boolean

})

Not precise types

In some cases runtime type assertions provide stronger guarantees than static types.

For example $.finite asserts that the value is not only a number but also that is not NaN, Infinity or -Infinity.

Opaque types section provides solution for some cases.

Opaque types

Unlike Flow, TypeScript doesn't directly support opaque types.

However, they can be emulated by intersecting with object containing unique property type which exists in static type system only. It does not exist in runtime value.

type Finite = number & { readonly _tag: 'Finite' }

Opaque types allow to design code in such a way that value of the type can be created in one place – as result of runtime type assertion – only. The only possible way of creating values of this type is to create valid values. Those assertions have to happen at construction and I/O boundaries only. Once value is validated, it enters static type system. It doesn't have to be re-validated anywhere else in the code. Usage of the value is safe, guaranteed to conform to this assertion.

Good examples of opaque type candidates are NonEmptyArray<T>, Positive, Email. ValidatedEmail – ie. an email that passed some async validation can be used to annotate function parameter for functions that should be used only for validated emails – without the need for re-validating email in each function's body.

Optional tuple tail

When tail of tuple accepts undefined values, resulting tuple may have shorter length than arity of assertion function.

const assertMyTuple = $.tuple($.string, $.undefinedOr($.number))
assertMyTuple([ 'foo' ]) // ok
assertMyTuple([ 'foo', 1 ]) // ok

A good rule of thumb is to destructure tuple elements if it accepts undefined at tail position to make sure the code doesn't rely on the length, ie:

const [ myString, maybeNumber ] = assertMyTuple(input)

Exhaustive switch

Use never assertion to force exhaustiveness on switch statements:

import * as $ from '@appliedblockchain/assert-combinators'

type X = 'a' | 'b' | 'c'

const assertX: $.Assert<X> =
  $.oneOf('a', 'b', 'c')

const x: X = assertX(JSON.parse('"c"'))
switch (x) {
  case 'a':
  case 'b':
    console.log(x)
    break
  default:

  // Argument of type 'string' is not assignable to parameter of type 'never'.ts(2345)
  // const x: "c"
  $.never(x)
}

License

MIT License

Copyright 2019 Applied Blockchain

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.