ArkType

TypeScript's 1:1 validator, optimized from editor to runtime

ValidationTypes
arktypeio/arktypearktype.ioarktype

README

ArkType


TypeScript's 1:1 validator

What is it?


ArkType is a runtime validation library that can infer TypeScript definitions 1:1 and reuse them as highly-optimized validators for your data.

With each character you type, you'll get immediate feedback from your editor in the form of either a fully-inferred Type or a specific and helpful ParseError.

This result exactly mirrors what you can expect to happen at runtime down to the punctuation of the error message- no plugins required.


  1. ```ts @blockFrom:dev/test/examples/type.ts
  2. import { type } from "arktype"

  4. // Definitions are statically parsed and inferred as TS.
  5. export const user = type({
  6.     name: "string",
  7.     device: {
  8.         platform: "'android'|'ios'",
  9.         "version?": "number"
  10.     }
  11. })

  13. // Validators return typed data or clear, customizable errors.
  14. export const { data, problems } = user({
  15.     name: "Alan Turing",
  16.     device: {
  17.         // problems.summary: "device/platform must be 'android' or 'ios' (was 'enigma')"
  18.         platform: "enigma"
  19.     }
  20. })
  21. ```

Check out how it works, try it in-browser, or scroll slightly to read about installation.



## Install 📦`12KB` gzipped, `0` dependencies

Npm Icon npm install arktype(or whatever package manager you prefer)

Our types are tested in strict-mode with TypeScript versions4.8, 4.9, and 5.0.

_Our APIs have mostly stabilized, but details may still change during the alpha/beta stages of our 1.0 release. If you have suggestions that may require a breaking change, now is the time to let us know!_ ⛵


Scopes


Try this example in-browser.

  1. ```ts @blockFrom:dev/test/examples/scope.ts
  2. import { scope } from "arktype"

  4. // Scopes are collections of types that can reference each other.
  5. export const types = scope({
  6.     package: {
  7.         name: "string",
  8.         "dependencies?": "package[]",
  9.         "contributors?": "contributor[]"
  10.     },
  11.     contributor: {
  12.         // Subtypes like 'email' are inferred like 'string' but provide additional validation at runtime.
  13.         email: "email",
  14.         "packages?": "package[]"
  15.     }
  16. }).compile()

  18. // Cyclic types are inferred to arbitrary depth...
  19. export type Package = typeof types.package.infer

  21. // And can validate cyclic data.
  22. const packageData: Package = {
  23.     name: "arktype",
  24.     dependencies: [{ name: "typescript" }],
  25.     contributors: [{ email: "david@sharktypeio" }]
  26. }
  27. packageData.dependencies![0].dependencies = [packageData]

  29. export const { data, problems } = types.package(packageData)
  30. ```

Syntax


This is an informal, non-exhaustive list of current and upcoming ArkType syntax.

There are some subjects it doesn't cover, primarily tuple expressions and scopes. As mentioned below, keep an eye out for comprehensive docs coming with the upcoming beta release. In the meantime, join our Discord or head to our GitHub Discussions to ask a question and there's a good chance you'll see a response within the hour 😊

  1. ```ts
  2. export const currentTsSyntax = type({
  3.     keyword: "null",
  4.     stringLiteral: "'TS'",
  5.     numberLiteral: "5",
  6.     bigintLiteral: "5n",
  7.     union: "string|number",
  8.     intersection: "boolean&true",
  9.     array: "Date[]",
  10.     grouping: "(0|1)[]",
  11.     objectLiteral: {
  12.         nested: "string",
  13.         "optional?": "number"
  14.     },
  15.     tuple: ["number", "number"]
  16. })

  18. // these features will be available in the upcoming release

  20. export const upcomingTsSyntax = type({
  21.     keyof: "keyof bigint",
  22.     thisKeyword: "this", // recurses to the root of the current type
  23.     variadicTuples: ["true", "...false[]"]
  24. })

  26. export const validationSyntax = type({
  27.     keywords: "email|uuid|creditCard|integer", // and many more
  28.     builtinParsers: "parsedDate", // parses a Date from a string
  29.     nativeRegexLiteral: /@arktype\.io/,
  30.     embeddedRegexLiteral: "email&/@arktype\\.io/",
  31.     divisibility: "number%10", // a multiple of 10
  32.     bound: "alpha>10", // an alpha-only string with more than 10 characters
  33.     range: "1<=email[]<99", // a list of 1 to 99 emails
  34.     narrows: ["number", "=>", (n) => n % 2 === 1], // an odd integer
  35.     morphs: ["string", "|>", parseFloat] // validates a string input then parses it to a number
  36. })

  38. // in the upcoming release, you can use chaining to define expressions directly
  39. // that use objects or functions that can't be embedded in strings

  41. export const parseBigintLiteral = type({ value: "string" })
  42.     .and({
  43.         format: "'bigint'"
  44.     })
  45.     .narrow((data): data is { value: `${string}n`; format: "bigint" } =>
  46.         data.value.endsWith("n")
  47.     )
  48.     .morph((data) => BigInt(data.value.slice(-1)))

  50. export const { data, problems } = parseBigintLiteral("999n")
  51. //             ^ bigint | undefined
  52. ```

API



ArkType supports many of TypeScript's built-in types and operators, as well as some new ones dedicated exclusively to runtime validation. In fact, we got a little ahead of ourselves and built a ton of cool features, but we're still working on getting caught up syntax and API docs. Keep an eye out for more in the next couple weeks ⛵

In the meantime, check out the examples here and use the type hints you get to learn how you can customize your types and scopes. If you want to explore some of the more advanced features, take a look at our unit tests or ask us on Discord if your functionality is supported. If not, create a GitHub issue so we can prioritize it!


Integrations


tRPC


ArkType can easily be used with tRPC via the assert prop:

  1. ```ts
  2. ...
  3. t.procedure
  4.   .input(
  5.     type({
  6.       name: "string",
  7.       "age?": "number"
  8.     }).assert
  9.   )
  10. ...
  11. ```

How?


ArkType's isomorphic parser has parallel static and dynamic implementations. This means as soon as you type a definition in your editor, you'll know the eventual result at runtime.

If you're curious, below is an example of what that looks like under the hood. If not, close that hood back up, npm install arktype and enjoy top-notch developer experience 🧑‍💻

  1. ```ts @blockFrom:src/parse/string/shift/operator/operator.ts:parseOperator
  2. export const parseOperator = (s: DynamicState): void => {
  3.     const lookahead = s.scanner.shift()
  4.     return lookahead === ""
  5.         ? s.finalize()
  6.         : lookahead === "["
  7.         ? s.scanner.shift() === "]"
  8.             ? s.rootToArray()
  9.             : s.error(incompleteArrayTokenMessage)
  10.         : isKeyOf(lookahead, Scanner.branchTokens)
  11.         ? s.pushRootToBranch(lookahead)
  12.         : lookahead === ")"
  13.         ? s.finalizeGroup()
  14.         : isKeyOf(lookahead, Scanner.comparatorStartChars)
  15.         ? parseBound(s, lookahead)
  16.         : lookahead === "%"
  17.         ? parseDivisor(s)
  18.         : lookahead === " "
  19.         ? parseOperator(s)
  20.         : throwInternalError(writeUnexpectedCharacterMessage(lookahead))
  21. }

  23. export type parseOperator<s extends StaticState> =
  24.     s["unscanned"] extends Scanner.shift<infer lookahead, infer unscanned>
  25.         ? lookahead extends "["
  26.             ? unscanned extends Scanner.shift<"]", infer nextUnscanned>
  27.                 ? state.setRoot<s, [s["root"], "[]"], nextUnscanned>
  28.                 : error<incompleteArrayTokenMessage>
  29.             : lookahead extends Scanner.BranchToken
  30.             ? state.reduceBranch<s, lookahead, unscanned>
  31.             : lookahead extends ")"
  32.             ? state.finalizeGroup<s, unscanned>
  33.             : lookahead extends Scanner.ComparatorStartChar
  34.             ? parseBound<s, lookahead, unscanned>
  35.             : lookahead extends "%"
  36.             ? parseDivisor<s, unscanned>
  37.             : lookahead extends " "
  38.             ? parseOperator<state.scanTo<s, unscanned>>
  39.             : error<writeUnexpectedCharacterMessage<lookahead>>
  40.         : state.finalize<s>
  41. ```

Contributions


We accept and encourage pull requests from outside ArkType.

Depending on your level of familiarity with type systems and TS generics, some parts of the codebase may be hard to jump into. That said, there's plenty of opportunities for more straightforward contributions.

If you're planning on submitting a non-trivial fix or a new feature, please create an issue first so everyone's on the same page. The last thing we want is for you to spend time on a submission we're unable to merge.

When you're ready, check out our guide to get started!

License


This project is licensed under the terms of the
MIT license.

Collaboration


I'd love to hear about what you're working on and how ArkType can help. Please reach out to david@arktype.io.

Code of Conduct


We will not tolerate any form of disrespect toward members of our community. Please refer to our Code of Conduct and reach out to david@arktype.io immediately if you've seen or experienced an interaction that may violate these standards.

Sponsorship


We've been working full-time on this project for over a year and it means a lot to have the community behind us.

If the project has been useful to you and you are in a financial position to do so, please chip in via GitHub Sponsors.

Otherwise, consider sending me an email (david@arktype.io) or message me on Discord to let me know you're a fan of ArkType. Either would make my day!

Current Sponsors 🥰


[tmm](https://github.com/tmm)[xrexy](https://github.com/xrexy)[thomasballinger](https://github.com/thomasballinger)[codeandcats](https://github.com/codeandcats)|
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
|