Package Exports
- io-ts-types
- io-ts-types/lib/fp-ts/createOptionFromNullable
- io-ts-types/lib/fromNullable
- io-ts-types/lib/mapOutput
- io-ts-types/lib/newtype-ts/fromNewtype
- io-ts-types/lib/number/IntegerFromString
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (io-ts-types) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
A collection of runtime types and combinators for use with io-ts
API
mapOutput
Changes the output type of the given runtime type
import { mapOutput } from 'io-ts-types/lib/mapOutput'
import { createOptionFromNullable } from 'io-ts-types/lib/fp-ts/createOptionFromNullable'
// Input: t.Type<Option<number>, number | null, t.mixed>
const Input = createOptionFromNullable(t.number)
const toUndefined = <A>(x: A | null): A | undefined => (x === null ? undefined : x)
// Output: t.Type<Option<number>, number | undefined, t.mixed>
const Output = mapOutput(Input, toUndefined)
assert.strictEqual(T.encode(none), undefined)
assert.strictEqual(T.encode(some(1)), 1)
Date
DateFromISOString
import { DateFromISOString } from 'io-ts-types/lib/Date/DateFromISOString'
const input = new Date(1973, 10, 30).toISOString()
DateFromISOString.decode(input) // right(new Date(...))
DateFromNumber
import { DateFromNumber } from 'io-ts-types/lib/Date/DateFromNumber'
const input = new Date(1973, 10, 30).getTime()
DateFromNumber.decode(input) // right(new Date(...))
DateFromUnixTime
import { DateFromUnixTime } from 'io-ts-types/lib/Date/DateFromUnixTime'
const input = new Date(1973, 10, 30).getTime() / 1000
DateFromUnixTime.decode(input) // right(new Date(...))
fp-ts
createEitherFromJSON
import * as t from 'io-ts'
import { createEitherFromJSON } from 'io-ts-types/lib/fp-ts/createEitherFromJSON'
const T = createEitherFromJSON(t.string, t.number)
T.decode({ type: 'Left', value: 's' }) // right(left('s'))
T.decode({ type: 'Right', value: 1 }) // right(right(1))
createNonEmptyArrayFromArray
import * as t from 'io-ts'
import { createNonEmptyArrayFromArray } from 'io-ts-types/lib/fp-ts/createNonEmptyArrayFromArray'
const T = createNonEmptyArrayFromArray(t.number)
T.decode([1, 2, 3]) // right(new NonEmptyArray(1, [2, 3]))
createOptionFromJSON
import * as t from 'io-ts'
import { createOptionFromJSON } from 'io-ts-types/lib/fp-ts/createOptionFromJSON'
const T = createOptionFromJSON(t.number)
T.decode({ type: 'Option', value: null }) // right(none)
T.decode({ type: 'Option', value: undefined }) // right(none)
T.decode({ type: 'Option', value: 1 }) // right(some(1))
createOptionFromNullable
import * as t from 'io-ts'
import { createOptionFromNullable } from 'io-ts-types/lib/fp-ts/createOptionFromNullable'
const T = createOptionFromNullable(t.number)
T1.decode(null) // right(none)
T1.decode(undefined) // right(none)
T1.decode(1) // right(some(1))
createSetFromArray
import * as t from 'io-ts'
import { ordNumber } from 'fp-ts/lib/Ord'
import { createSetFromArray } from 'io-ts-types/lib/fp-ts/createSetFromArray'
const T = createSetFromArray(t.number, ordNumber)
T.decode([1, 2, 3] // Set([1, 2, 3])
createStrMapFromDictionary
import * as t from 'io-ts'
import { createStrMapFromDictionary } from 'io-ts-types/lib/fp-ts/createStrMapFromDictionary'
const T = createStrMapFromDictionary(t.number)
T.decode({ someNumber: 42 }) // StrMap<number>({ someNumber: 42 })
T.encode(new StrMap({ someNumber: 42 })) // { someNumber: 42 }
JSON
JSONFromString
import { JSONFromString } from 'io-ts-types/lib/fp-ts/JSONFromString'
JSONFromString.decode('{"name":"Giulio"}') // right({ name: 'Giulio' })
JSONTypeRT
import { JSONTypeRT } from 'io-ts-types/lib/fp-ts/JSONTypeRT'
JSONTypeRT.decode({ name: 'Giulio' }) // right({ name: 'Giulio' })
monocle-ts
lensesFromInterface
import * as t from 'io-ts'
import { lensesFromInterface } from 'io-ts-types/lib/monocle-ts/lensesFromInterface'
const Person = t.type({
name: t.string,
age: t.number
})
/** return a Lens for each prop */
const lenses = lensesFromInterface(Person)
lenses.age.get({ name: 'Giulio', age: 44 }) // 44
lensesFromProps
import * as t from 'io-ts'
import { lensesFromProps } from 'io-ts-types/lib/monocle-ts/lensesFromProps'
/** return a Lens for each prop */
const lenses = lensesFromProps({
name: t.string,
age: t.number
})
lenses.age.get({ name: 'Giulio', age: 44 }) // 44
TypePrismIso
import * as t from 'io-ts'
import { get } from 'io-ts-types/lib/monocle-ts/TypePrismIso'
import { NumberFromString } from 'io-ts-types/lib/number/NumberFromString'
// given a runtime type, returns a Prism
const prism = get(NumberFromString)
prism.getOption('1') // some(1)
prism.getOption('a') // none
import { Prism } from 'monocle-ts'
// given a Prism, returns a runtime type
import { Prism } from 'monocle-ts'
import { none, some } from 'fp-ts/lib/Option'
import { reverseGet } from 'io-ts-types/lib/monocle-ts/TypePrismIso'
const numberFromStringPrism = new Prism<string, number>(s => {
const n = parseFloat(s)
return isNaN(n) ? none : some(n)
}, String)
const MyNumberFromString = reverseGet('MyNumberFromString', numberFromStringPrism, t.number.is)
newtype-ts
fromNewtype
Given
import { Newtype, iso } from 'newtype-ts'
type Age = Newtype<'Age', number>
I want to define a runtime type whose derived type is
type Person = {
name: string
age: Age
}
Solution
import * as t from 'io-ts'
import { fromNewtype } from 'io-ts-types/lib/newtype-ts/fromNewtype'
const Person = t.type({
name: t.string,
age: fromNewtype<Age>(t.Integer)
})
Usage example
import { iso } from 'newtype-ts'
import { Lens } from 'monocle-ts'
type Person = t.TypeOf<typeof Person>
const ageLens = Lens.fromProp<Person, 'age'>('age').composeIso(iso<Age>())
const sum = (a: number) => (b: number) => a + b
console.log(Person.decode({ name: 'Giulio', age: 44 }).map(ageLens.modify(sum(1))))
// => right({ name: 'Giulio', age: 44 })
number
IntegerFromString
import { IntegerFromString } from 'io-ts-types/lib/number/IntegerFromString'
IntegerFromString.decode('1') // right(1)
IntegerFromString.decode('1.1') // left(...)
NumberFromString
import { NumberFromString } from 'io-ts-types/lib/number/NumberFromString'
NumberFromString.decode('1') // right(1)
NumberFromString.decode('1.1') // right(1.1)
string
uuid
import { uuid } from 'io-ts-types/lib/string/uuid'
uuid.decode('6e9c5587-a342-4b63-a901-87b31fa2ffa3') // right('6e9c5587-a342-4b63-a901-87b31fa2ffa3')