Documentation tool for tcomb
API
toObject
Signature
JSON blob / JavaScript object
Example
const Person = t console
Output
"kind": "struct" "name": "User" "required": true "props": "name": "kind": "irreducible" "name": "String" "required": true "age": "kind": "irreducible" "name": "Number" "required": false
Output format
Irriducible
Source
tString
Output
"kind": "irreducible" "required": true "name": "String" "predicate": "<function reference>"
Refinement
Source
const Password = t
Output
"kind": "refinement" "required": true "name": "Password" "type": "kind": "irreducible" "name": "String" "required": true "predicate": "<function reference>" "predicate": "<function reference>"
Maybe
Source
const MaybeString = t
Output
"kind": "irreducible" "required": false "name": "String" "predicate": "<function reference>"
Enum
Source
const Country = t
Output
"kind": "enums" "required": false "name": "Country" "map": IT: 'Italy' US: 'United States'
Struct
Source
const Person = t
Output
"kind": "struct" "required": false "name": "Person" "props": "name": "kind": "irreducible" "required": true "name": "String" "predicate": "<function reference>" ...
List
Source
const Tags = t
Output
"kind": "list" "required": true "name": "Tags" "type": "kind": "irreducible" "name": "String" "required": true "predicate": "<function reference>"
Tuple
Source
const Tuple = t
Output
"kind": "tuple" "name": "Tuple" "required": true "types": "kind": "irreducible" "required": true "name": "String" "predicate": "<function reference>" "kind": "irreducible" "required": true "name": "Number" "predicate": "<function reference>"
Union
Source
const Union = t
Output
"kind": "union" "name": "Union" "required": true "types": "kind": "irreducible" "required": true "name": "String" "predicate": "<function reference>" "kind": "irreducible" "required": true "name": "Number" "predicate": "<function reference>" "dispatch": "<function reference>"
Dict
Source
const Dict = t
Output
"kind": "dict" "name": "Dict" "required": true "domain": "kind": "irreducible" "required": true "name": "String" "predicate": "<function reference>" "codomain": "kind": "irreducible" "required": true "name": "Number" "predicate": "<function reference>"