typebox
typescript-is
Our great sponsors
typebox | typescript-is | |
---|---|---|
56 | 9 | |
4,088 | 949 | |
- | - | |
8.8 | 4.2 | |
4 days ago | 9 months ago | |
TypeScript | TypeScript | |
GNU General Public License v3.0 or later | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
typebox
-
I write HTTP services in Go after 13 years (Mat Ryer, 2024)
So far I like the commonly used approach in the Typescript community best:
1. Create your Schema using https://zod.dev or https://github.com/sinclairzx81/typebox
2. Generate your Types from the schema. It's very simple to create partial or composite types, e.g. UpdateModel, InsertModels, Arrays of them, etc.
3. Most modern Frameworks have first class support for validation, like is a great example Fastify (with typebox). Just reuse your schema definition.
That is very easy, obvious and effective.
- Where DRY Applies
-
Has anybody used Typia library?
There's a ton of schema validators out there and most devs have their personal favorite. Mine was zod and is now typebox + ajv.
- I'm looking to use my openapi spec to dyanamically create types
-
How can I generate typescript types?
If you're willing to document your API with an OpenAPI schema, then it should be possible to generate TypeScript types based on the OpenAPI schema with something like openapi-typescript. Also, Typebox can generate JSON schemas, maybe it can be used to generate something that the front-end can also use?
-
[AskTS] What do you think will be the future of runtime type checking?
Well, I do provide extensibility for those bullet points you've listed to varying degrees (both schema and type representation), as well as offering a reference implementation for expressing a entirely different schema specification under the type system (specifically RFC8927 / JSON Type Definition). Reference implementation here. As for JSDoc, It's supported in code hints.
- TypeBox: Runtime Type System Built on Industry Standards
-
Building a modern gRPC-powered microservice using Node.js, Typescript, and Connect
In setting out to build this service, we wanted to use gRPC for its APIs. We’ve been reaching for REST when building APIs so far, primarily out of necessity, i.e., our public APIs needed auto-generated client SDKs and docs for developers working with them. We built those APIs with Fastify and Typebox but felt burned by a code-first approach to generating an OpenAPI spec. I’ll spare you the details and save that experience/learning for another article. Suffice it to say we love gRPC’s schema-first approach. This blog post summarizes our feelings well
-
IS there a way to generate Swagger model schemas from interfaces
You could try using @sinclair/typebox, it's API is similar to that of zod, but it spits out a JSON schema that you can then use to validate data at runtime and to populate your Swagger docs.
- TypeBox: Template Literals + Conditional Types at Runtime
typescript-is
- Good bye "typescript-is" (ancestor of "typia", 20,000x faster validator)
-
Typing for JSON Payloads
I'll throw https://github.com/woutervh-/typescript-is in the mix as well.
-
Handling json input in an express app
I'm a fan of typescript-is. Provides both compile time and run time validations
-
What can I *use* Rust for?
For what it's worth, thanks to TypeScript transformers (a feature baked into the compiler), one can create a transformer library that verifies an object is valid for any TypeScript type and conveys that information to the typechecker. And indeed, it's already been made. It allows to parse unknown into a given T. This is nice, because one can generate a JSON schema out of a TS type, for other languages/codebases to integrate safely.
-
TypeScript runtime type-checking - designed for simple use, through to enforcing API payload schema
Then there's also typescript-is, which is pretty neat because it converts actual compile-time type definitions to runtime type checks, so it doesn't require changing the type definitions.
-
JSON Schema === Runtime Type System for TypeScript
typescript-is. This uses a compile-time transformer to generate code for type-checking. You'll need to use ttypescript instead of typescript to compile your code (I recommend setting this up with ts-patch). It won't work if your build pipeline is actually using something like esbuild or Babel to transpile TS->JS.
-
How an Anti-TypeScript “JavaScript developer” like me became a TypeScript fan
If you're not using a bunch of generics, check out typescript-is [1]. It takes little work to get it setup, but it generates run time type checks for you. I understand why typescript decided to not add this functionality to the core of the language, but it's starting to feel like the largest missing piece of typescript is a built-in way to generate run-time type-checks for user-defined types from just the type definition.
The happy medium we've found with that module is using the runtime type-check on anything "unsafe" to bless the result using typescript-is's equals functionality, but still allowing programmers to use casting with a comment justifying its necessity. For us our list of unsafe is results pulled from the db, anything parsed from JSON, and incoming request bodies (which can be a special case of parsing from JSON, but not always).
What are some alternatives?
zod - TypeScript-first schema validation with static type inference
zod-to-json-schema - Converts Zod schemas to Json schemas
ajv - The fastest JSON schema Validator. Supports JSON Schema draft-04/06/07/2019-09/2020-12 and JSON Type Definition (RFC8927)
runtypes - Runtime validation for static types
class-validator - Decorator-based property validation for classes.
openapi-typescript-validator - Generate typescript with ajv validation based on openapi schemas
class-transformer - Decorator-based transformation, serialization, and deserialization between objects and classes.
ts-json-schema-generator - Generate JSON schema from your Typescript sources
io-ts - Runtime type system for IO decoding/encoding
fluent-json-validator - An easy-to-use, expressive, and composable JSON object validator, with a fluent builder pattern interface!