Skip to content

docs: tweak wording #1012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ericcrosson-bitgo wants to merge 1 commit into from
Closed

docs: tweak wording #1012

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions website/docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ sidebar_position: 1

# Introduction

`io-ts-http` brings type safety to HTTP data handling in TypeScript by embracing the
"[parse, don't validate]" philosophy. Rather than simply checking if incoming HTTP data
is valid, it also parses raw, less-structured data (like strings or JSON) into strongly
typed, precise objects using the `io-ts` library. This parsing happens at the system
boundary, ensuring all types have use cases in your code. Once parsed, you can trust the
data satisfies both [type and semantic analysis].
`api-ts` brings type safety to TypeScript HTTP servers by embracing the "[parse, don't
validate]" philosophy. In addition to validating incoming HTTP requests against your API
specification, `api-ts` also parses raw, less-structured data (like strings or JSON)
into strongly-typed domain objects using the `io-ts` library. Once parsed, you can trust
the HTTP request has passed both [type and semantic validation], ensuring your business
logic is never called with data it can't handle.

[parse, don't validate]:
https://lexi-lambda.github.io/blog/2019/11/05/parse-don-t-validate/
Expand Down