File tree Expand file tree Collapse file tree 1 file changed +17
-1
lines changed Expand file tree Collapse file tree 1 file changed +17
-1
lines changed Original file line number Diff line number Diff line change 33** Disclaimer: This project is currently in an alpha state. Documentation is actively
44being worked on.**
55
6+ A collection of packages for defining and using type-checked apis with TypeScript.
7+
8+ TypeScript is a very powerful type system layered on top of JavaScript, but lacks type
9+ information available at runtime. This is not likely to change because it is
10+ [ an explicit non-goal] ( https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals#non-goals )
11+ of TypeScript. [ io-ts] ( https://github.com/gcanti/io-ts ) fills in this functionality gap.
12+ [ io-ts-http] ( packages/io-ts-http/README.md ) builds on top of ` io-ts ` to make it possible
13+ to define codecs that translate between HTTP requests and plain JS objects.
14+ Additionally, it provides a way to group these codecs into route definitions, and then
15+ collect the route definitions into an api. The resulting api definitions may then be
16+ used on the [ client] ( packages/superagent-wrapper/README.md ) and
17+ [ server] ( packages/express-wrapper/README.md ) to have type-checked and runtime-validated
18+ HTTP calls in a standardized manner.
19+
20+ ## Getting started
21+
622``` sh
723npm install
824npm run build
925npm test
1026```
1127
12- # License
28+ ## License
1329
1430This work is published under the Apache 2.0 license.
1531
You can’t perform that action at this time.
0 commit comments