Skip to content

Commit 641efa4

Browse files
docs: tweak wording
The primary focus of this commit was to avoid the phrase "ensuring all types have use cases in your code," which didn't strike me as crystal clear to the imaginary reader. The rest of the changes came from helping that phrase's replacement land.
1 parent 3f91d44 commit 641efa4

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

website/docs/intro.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ sidebar_position: 1
44

55
# Introduction
66

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

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

0 commit comments

Comments
 (0)