[API reference](https://evolu.dev/docs/api-reference) › [@evolu/common](https://evolu.dev/docs/api-reference/common) › Type Runtime type validation, parsing, and branded types. ## Base Types | Variable | Description | | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [BigInt](https://evolu.dev/docs/api-reference/common/Type/variables/BigInt) | - | | [Boolean](https://evolu.dev/docs/api-reference/common/Type/variables/Boolean) | - | | [Date](https://evolu.dev/docs/api-reference/common/Type/variables/Date) | JavaScript Date. | | [Function](https://evolu.dev/docs/api-reference/common/Type/variables/Function) | - | | [JsonValue](https://evolu.dev/docs/api-reference/common/Type/variables/JsonValue) | JSON-compatible value: string, [FiniteNumber](https://evolu.dev/docs/api-reference/common/Type/variables/FiniteNumber), boolean, null, [JsonArray](https://evolu.dev/docs/api-reference/common/Type/variables/JsonArray), or [JsonObject](https://evolu.dev/docs/api-reference/common/Type/variables/JsonObject). | | [Null](https://evolu.dev/docs/api-reference/common/Type/variables/Null) | - | | [Number](https://evolu.dev/docs/api-reference/common/Type/variables/Number) | - | | [String](https://evolu.dev/docs/api-reference/common/Type/variables/String) | - | | [Uint8Array](https://evolu.dev/docs/api-reference/common/Type/variables/Uint8Array) | - | | [Undefined](https://evolu.dev/docs/api-reference/common/Type/variables/Undefined) | - | | [Unknown](https://evolu.dev/docs/api-reference/common/Type/variables/Unknown) | - | ## Base factories | Function | Description | | ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | | [array](https://evolu.dev/docs/api-reference/common/Type/functions/array) | Array of a specific [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [base](https://evolu.dev/docs/api-reference/common/Type/functions/base) | Base [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [brand](https://evolu.dev/docs/api-reference/common/Type/functions/brand) | Branded [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [instanceOf](https://evolu.dev/docs/api-reference/common/Type/functions/instanceOf) | `instanceof` [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [literal](https://evolu.dev/docs/api-reference/common/Type/functions/literal) | Literal [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [nullishOr](https://evolu.dev/docs/api-reference/common/Type/functions/nullishOr) | `union(undefined, null, T)` [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [nullOr](https://evolu.dev/docs/api-reference/common/Type/functions/nullOr) | `union(null, T)` [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [object](https://evolu.dev/docs/api-reference/common/Type/functions/object) | Object [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [record](https://evolu.dev/docs/api-reference/common/Type/functions/record) | Record of a key [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) and value [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [recursive](https://evolu.dev/docs/api-reference/common/Type/functions/recursive) | Recursive [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [set](https://evolu.dev/docs/api-reference/common/Type/functions/set) | Set of a specific [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [tuple](https://evolu.dev/docs/api-reference/common/Type/functions/tuple) | Tuple [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [undefinedOr](https://evolu.dev/docs/api-reference/common/Type/functions/undefinedOr) | `union(undefined, T)` [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [union](https://evolu.dev/docs/api-reference/common/Type/functions/union) | Union [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | ## Composite factories | Name | Description | | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [UnknownNextResult](https://evolu.dev/docs/api-reference/common/Type/type-aliases/UnknownNextResult) | A [nextResult](https://evolu.dev/docs/api-reference/common/Type/functions/nextResult) type for `NextResult`. | | [UnknownResult](https://evolu.dev/docs/api-reference/common/Type/type-aliases/UnknownResult) | A [result](https://evolu.dev/docs/api-reference/common/Type/functions/result) type for `Result`. | | [UnknownNextResult](https://evolu.dev/docs/api-reference/common/Type/variables/UnknownNextResult) | A [nextResult](https://evolu.dev/docs/api-reference/common/Type/functions/nextResult) type for `NextResult`. | | [UnknownResult](https://evolu.dev/docs/api-reference/common/Type/variables/UnknownResult) | A [result](https://evolu.dev/docs/api-reference/common/Type/functions/result) type for `Result`. | | [nextResult](https://evolu.dev/docs/api-reference/common/Type/functions/nextResult) | Creates a [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) for [NextResult](https://evolu.dev/docs/api-reference/common/Result/type-aliases/NextResult) with three outcomes. | | [result](https://evolu.dev/docs/api-reference/common/Type/functions/result) | Creates a [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) for [Result](https://evolu.dev/docs/api-reference/common/Result/type-aliases/Result) values. | ## String | Name | Description | | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Base64Url](https://evolu.dev/docs/api-reference/common/Type/type-aliases/Base64Url) | Base64Url without padding. | | [CurrencyCode](https://evolu.dev/docs/api-reference/common/Type/type-aliases/CurrencyCode) | A three-letter ISO 4217 currency code (e.g., USD, EUR). | | [DateIso](https://evolu.dev/docs/api-reference/common/Type/type-aliases/DateIso) | ISO 8601 date-time string. | | [Id](https://evolu.dev/docs/api-reference/common/Type/type-aliases/Id) | Evolu Id: 16 bytes encoded as a 22‑character Base64Url string. | | [Int64String](https://evolu.dev/docs/api-reference/common/Type/type-aliases/Int64String) | Stringified [Int64](https://evolu.dev/docs/api-reference/common/Type/variables/Int64). | | [Json](https://evolu.dev/docs/api-reference/common/Type/type-aliases/Json) | JSON-string [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [Mnemonic](https://evolu.dev/docs/api-reference/common/Type/type-aliases/Mnemonic) | The mnemonic, also known as a "seed phrase," is a set of 12 words in a specific order chosen from a predefined list (BIP39). It provides a human-readable way to store a private key securely. The mnemonic is generated safely on the user's device using cryptographically secure random number generation, ensuring it remains private and unique. | | [Name](https://evolu.dev/docs/api-reference/common/Type/type-aliases/Name) | Alphanumeric string for naming in file systems, URLs, and identifiers. | | [NonEmptyString](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NonEmptyString) | - | | [NonEmptyString100](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NonEmptyString100) | - | | [NonEmptyString1000](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NonEmptyString1000) | - | | [NonEmptyTrimmedString](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NonEmptyTrimmedString) | - | | [NonEmptyTrimmedString100](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NonEmptyTrimmedString100) | - | | [NonEmptyTrimmedString1000](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NonEmptyTrimmedString1000) | - | | [SimplePassword](https://evolu.dev/docs/api-reference/common/Type/type-aliases/SimplePassword) | Trimmed string between 8 and 64 characters, branded as `SimplePassword`. | | [String100](https://evolu.dev/docs/api-reference/common/Type/type-aliases/String100) | - | | [String1000](https://evolu.dev/docs/api-reference/common/Type/type-aliases/String1000) | - | | [TrimmedString](https://evolu.dev/docs/api-reference/common/Type/type-aliases/TrimmedString) | Trimmed string | | [TrimmedString100](https://evolu.dev/docs/api-reference/common/Type/type-aliases/TrimmedString100) | - | | [TrimmedString1000](https://evolu.dev/docs/api-reference/common/Type/type-aliases/TrimmedString1000) | - | | [UrlSafeString](https://evolu.dev/docs/api-reference/common/Type/type-aliases/UrlSafeString) | URL-safe string. | | [Base64Url](https://evolu.dev/docs/api-reference/common/Type/variables/Base64Url) | Base64Url without padding. | | [CurrencyCode](https://evolu.dev/docs/api-reference/common/Type/variables/CurrencyCode) | A three-letter ISO 4217 currency code (e.g., USD, EUR). | | [DateIso](https://evolu.dev/docs/api-reference/common/Type/variables/DateIso) | ISO 8601 date-time string. | | [Id](https://evolu.dev/docs/api-reference/common/Type/variables/Id) | Evolu Id: 16 bytes encoded as a 22‑character Base64Url string. | | [Int64String](https://evolu.dev/docs/api-reference/common/Type/variables/Int64String) | Stringified [Int64](https://evolu.dev/docs/api-reference/common/Type/variables/Int64). | | [Json](https://evolu.dev/docs/api-reference/common/Type/variables/Json) | JSON-string [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [length](https://evolu.dev/docs/api-reference/common/Type/variables/length) | Exact length. | | [maxLength](https://evolu.dev/docs/api-reference/common/Type/variables/maxLength) | Maximum length. | | [minLength](https://evolu.dev/docs/api-reference/common/Type/variables/minLength) | Minimum length. | | [Mnemonic](https://evolu.dev/docs/api-reference/common/Type/variables/Mnemonic) | The mnemonic, also known as a "seed phrase," is a set of 12 words in a specific order chosen from a predefined list (BIP39). It provides a human-readable way to store a private key securely. The mnemonic is generated safely on the user's device using cryptographically secure random number generation, ensuring it remains private and unique. | | [Name](https://evolu.dev/docs/api-reference/common/Type/variables/Name) | Alphanumeric string for naming in file systems, URLs, and identifiers. | | [NonEmptyString](https://evolu.dev/docs/api-reference/common/Type/variables/NonEmptyString) | - | | [NonEmptyString100](https://evolu.dev/docs/api-reference/common/Type/variables/NonEmptyString100) | - | | [NonEmptyString1000](https://evolu.dev/docs/api-reference/common/Type/variables/NonEmptyString1000) | - | | [NonEmptyTrimmedString](https://evolu.dev/docs/api-reference/common/Type/variables/NonEmptyTrimmedString) | - | | [NonEmptyTrimmedString100](https://evolu.dev/docs/api-reference/common/Type/variables/NonEmptyTrimmedString100) | - | | [NonEmptyTrimmedString1000](https://evolu.dev/docs/api-reference/common/Type/variables/NonEmptyTrimmedString1000) | - | | [regex](https://evolu.dev/docs/api-reference/common/Type/variables/regex) | String matching a regular expression. | | [SimplePassword](https://evolu.dev/docs/api-reference/common/Type/variables/SimplePassword) | Trimmed string between 8 and 64 characters, branded as `SimplePassword`. | | [String](https://evolu.dev/docs/api-reference/common/Type/variables/String) | - | | [String100](https://evolu.dev/docs/api-reference/common/Type/variables/String100) | - | | [String1000](https://evolu.dev/docs/api-reference/common/Type/variables/String1000) | - | | [trimmed](https://evolu.dev/docs/api-reference/common/Type/variables/trimmed) | Trimmed string. | | [TrimmedString](https://evolu.dev/docs/api-reference/common/Type/variables/TrimmedString) | Trimmed string | | [TrimmedString100](https://evolu.dev/docs/api-reference/common/Type/variables/TrimmedString100) | - | | [TrimmedString1000](https://evolu.dev/docs/api-reference/common/Type/variables/TrimmedString1000) | - | | [UrlSafeString](https://evolu.dev/docs/api-reference/common/Type/variables/UrlSafeString) | URL-safe string. | | [createIdFromString](https://evolu.dev/docs/api-reference/common/Type/functions/createIdFromString) | Creates an [Id](https://evolu.dev/docs/api-reference/common/Type/variables/Id) from a string using SHA-256. | | [id](https://evolu.dev/docs/api-reference/common/Type/functions/id) | Creates a branded [Id](https://evolu.dev/docs/api-reference/common/Type/variables/Id) Type for a table's primary key. | ## Number | Name | Description | | ------------------------------------------------------------------------------------------ | ---------------------------------------------------- | | [FiniteNumber](https://evolu.dev/docs/api-reference/common/Type/type-aliases/FiniteNumber) | Finite number. | | [Int](https://evolu.dev/docs/api-reference/common/Type/type-aliases/Int) | Integer within the safe range of JavaScript numbers. | | [Int64](https://evolu.dev/docs/api-reference/common/Type/type-aliases/Int64) | 64-bit signed integer. | | [NegativeInt](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NegativeInt) | Negative integer (< 0). | | [NegativeNumber](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NegativeNumber) | Negative number (< 0). | | [NonNaNNumber](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NonNaNNumber) | - | | [NonNegativeInt](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NonNegativeInt) | Non-negative integer (≥ 0). | | [NonNegativeNumber](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NonNegativeNumber) | Non-negative number (≥ 0). | | [NonPositiveInt](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NonPositiveInt) | Non-positive integer (≤ 0). | | [NonPositiveNumber](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NonPositiveNumber) | Non-positive number (≤ 0). | | [PositiveInt](https://evolu.dev/docs/api-reference/common/Type/type-aliases/PositiveInt) | Positive integer (> 0). | | [PositiveNumber](https://evolu.dev/docs/api-reference/common/Type/type-aliases/PositiveNumber) | Positive number (> 0). | | [between](https://evolu.dev/docs/api-reference/common/Type/variables/between) | Number within a range, inclusive. | | [finite](https://evolu.dev/docs/api-reference/common/Type/variables/finite) | Finite number. | | [FiniteNumber](https://evolu.dev/docs/api-reference/common/Type/variables/FiniteNumber) | Finite number. | | [greaterThan](https://evolu.dev/docs/api-reference/common/Type/variables/greaterThan) | Number greater than a specified value. | | [greaterThanOrEqualTo](https://evolu.dev/docs/api-reference/common/Type/variables/greaterThanOrEqualTo) | Number ≥ a specified value. | | [Int](https://evolu.dev/docs/api-reference/common/Type/variables/Int) | Integer within the safe range of JavaScript numbers. | | [Int64](https://evolu.dev/docs/api-reference/common/Type/variables/Int64) | 64-bit signed integer. | | [lessThan](https://evolu.dev/docs/api-reference/common/Type/variables/lessThan) | Number less than a specified value. | | [lessThanOrEqualTo](https://evolu.dev/docs/api-reference/common/Type/variables/lessThanOrEqualTo) | Number ≤ a specified value. | | [multipleOf](https://evolu.dev/docs/api-reference/common/Type/variables/multipleOf) | Number that is a multiple of a divisor. | | [negative](https://evolu.dev/docs/api-reference/common/Type/variables/negative) | Negative number (< 0). | | [NegativeInt](https://evolu.dev/docs/api-reference/common/Type/variables/NegativeInt) | Negative integer (< 0). | | [NegativeNumber](https://evolu.dev/docs/api-reference/common/Type/variables/NegativeNumber) | Negative number (< 0). | | [nonNaN](https://evolu.dev/docs/api-reference/common/Type/variables/nonNaN) | Number that is not NaN. | | [NonNaNNumber](https://evolu.dev/docs/api-reference/common/Type/variables/NonNaNNumber) | - | | [nonNegative](https://evolu.dev/docs/api-reference/common/Type/variables/nonNegative) | Non-negative number (≥ 0). | | [NonNegativeInt](https://evolu.dev/docs/api-reference/common/Type/variables/NonNegativeInt) | Non-negative integer (≥ 0). | | [NonNegativeNumber](https://evolu.dev/docs/api-reference/common/Type/variables/NonNegativeNumber) | Non-negative number (≥ 0). | | [nonPositive](https://evolu.dev/docs/api-reference/common/Type/variables/nonPositive) | Non-positive number (≤ 0). | | [NonPositiveInt](https://evolu.dev/docs/api-reference/common/Type/variables/NonPositiveInt) | Non-positive integer (≤ 0). | | [NonPositiveNumber](https://evolu.dev/docs/api-reference/common/Type/variables/NonPositiveNumber) | Non-positive number (≤ 0). | | [positive](https://evolu.dev/docs/api-reference/common/Type/variables/positive) | Positive number (> 0). | | [PositiveInt](https://evolu.dev/docs/api-reference/common/Type/variables/PositiveInt) | Positive integer (> 0). | | [PositiveNumber](https://evolu.dev/docs/api-reference/common/Type/variables/PositiveNumber) | Positive number (> 0). | ## Array | Name | Description | | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | | [JsonArray](https://evolu.dev/docs/api-reference/common/Type/type-aliases/JsonArray) | JSON-compatible array of [JsonValue](https://evolu.dev/docs/api-reference/common/Type/variables/JsonValue) elements. | | [JsonArray](https://evolu.dev/docs/api-reference/common/Type/variables/JsonArray) | JSON-compatible array of [JsonValue](https://evolu.dev/docs/api-reference/common/Type/variables/JsonValue) elements. | | [length](https://evolu.dev/docs/api-reference/common/Type/variables/length) | Exact length. | | [maxLength](https://evolu.dev/docs/api-reference/common/Type/variables/maxLength) | Maximum length. | | [minLength](https://evolu.dev/docs/api-reference/common/Type/variables/minLength) | Minimum length. | | [array](https://evolu.dev/docs/api-reference/common/Type/functions/array) | Array of a specific [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | ## Object | Name | Description | | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [JsonObject](https://evolu.dev/docs/api-reference/common/Type/variables/JsonObject) | JSON-compatible object with string keys and [JsonValue](https://evolu.dev/docs/api-reference/common/Type/variables/JsonValue) values. | | [nullableToOptional](https://evolu.dev/docs/api-reference/common/Type/functions/nullableToOptional) | Converts each “nullable” property (a union that includes [Null](https://evolu.dev/docs/api-reference/common/Type/variables/Null)) into an [optional](https://evolu.dev/docs/api-reference/common/Type/functions/optional) property. This means consumers can omit the property entirely, or set it to `null`, or set it to the non-null member of the union. | | [object](https://evolu.dev/docs/api-reference/common/Type/functions/object) | Object [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [omit](https://evolu.dev/docs/api-reference/common/Type/functions/omit) | Create a new `object` [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) by omitting some keys. | | [partial](https://evolu.dev/docs/api-reference/common/Type/functions/partial) | Creates a partial object type where all properties are optional. | | [record](https://evolu.dev/docs/api-reference/common/Type/functions/record) | Record of a key [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) and value [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | ## Utilities | Name | Description | | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [AnyType](https://evolu.dev/docs/api-reference/common/Type/type-aliases/AnyType) | A [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) with all type parameters set to `any`. | | [BrandFactory](https://evolu.dev/docs/api-reference/common/Type/type-aliases/BrandFactory) | Helper type for Type Factory that creates a branded Type. | | [InferError](https://evolu.dev/docs/api-reference/common/Type/type-aliases/InferError) | Extracts the specific error type from a [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [InferErrors](https://evolu.dev/docs/api-reference/common/Type/type-aliases/InferErrors) | Extracts all error types from a [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [InferInput](https://evolu.dev/docs/api-reference/common/Type/type-aliases/InferInput) | Extracts the input type from a [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [InferName](https://evolu.dev/docs/api-reference/common/Type/type-aliases/InferName) | Extracts the name from a [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [InferParent](https://evolu.dev/docs/api-reference/common/Type/type-aliases/InferParent) | Extracts the parent type from a [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [InferParentError](https://evolu.dev/docs/api-reference/common/Type/type-aliases/InferParentError) | Extracts the parent error type from a [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [InferType](https://evolu.dev/docs/api-reference/common/Type/type-aliases/InferType) | Extracts the type from a [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [MergeObjectTypeErrors](https://evolu.dev/docs/api-reference/common/Type/type-aliases/MergeObjectTypeErrors) | Merge Error and ParentError into one ObjectError so tooltips and error messages are easier to read. | | [TypeErrors](https://evolu.dev/docs/api-reference/common/Type/type-aliases/TypeErrors) | Union of all `TypeError`s defined in the `Type.ts` file, including base type errors (e.g., `StringError`, `NumberError`), composite type errors (`ArrayError`, `ObjectError`), and optionally, user-defined extra errors. | | [TypeName](https://evolu.dev/docs/api-reference/common/Type/type-aliases/TypeName) | Unique identifier for a [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [createBaseTypeErrorFormatter](https://evolu.dev/docs/api-reference/common/Type/functions/createBaseTypeErrorFormatter) | Creates a formatter function for a base [TypeError](https://evolu.dev/docs/api-reference/common/Type/interfaces/TypeError). | | [createFormatTypeError](https://evolu.dev/docs/api-reference/common/Type/functions/createFormatTypeError) | Formats Evolu Type errors into user-friendly messages. | | [createTypeErrorFormatter](https://evolu.dev/docs/api-reference/common/Type/functions/createTypeErrorFormatter) | Creates a formatter function for [TypeError](https://evolu.dev/docs/api-reference/common/Type/interfaces/TypeError). | | [isType](https://evolu.dev/docs/api-reference/common/Type/functions/isType) | Checks if the given value is an [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [typeErrorToStandardSchemaIssues](https://evolu.dev/docs/api-reference/common/Type/functions/typeErrorToStandardSchemaIssues) | Converts an Evolu [TypeError](https://evolu.dev/docs/api-reference/common/Type/interfaces/TypeError) to Standard Schema V1 issues format. | ## Functions | Function | Description | | -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | [createId](https://evolu.dev/docs/api-reference/common/Type/functions/createId) | Creates a random [Id](https://evolu.dev/docs/api-reference/common/Type/variables/Id). This is the recommended default. | | [createIdAsUuidv7](https://evolu.dev/docs/api-reference/common/Type/functions/createIdAsUuidv7) | Creates an [Id](https://evolu.dev/docs/api-reference/common/Type/variables/Id) embedding timestamp bits (UUID v7 layout) before Base64Url encoding. | | [dateIsoToDate](https://evolu.dev/docs/api-reference/common/Type/functions/dateIsoToDate) | - | | [dateToDateIso](https://evolu.dev/docs/api-reference/common/Type/functions/dateToDateIso) | - | | [formatArrayError](https://evolu.dev/docs/api-reference/common/Type/functions/formatArrayError) | - | | [formatObjectError](https://evolu.dev/docs/api-reference/common/Type/functions/formatObjectError) | - | | [formatObjectWithRecordError](https://evolu.dev/docs/api-reference/common/Type/functions/formatObjectWithRecordError) | - | | [formatRecordError](https://evolu.dev/docs/api-reference/common/Type/functions/formatRecordError) | - | | [formatSetError](https://evolu.dev/docs/api-reference/common/Type/functions/formatSetError) | - | | [formatSimplePasswordError](https://evolu.dev/docs/api-reference/common/Type/functions/formatSimplePasswordError) | - | | [formatTupleError](https://evolu.dev/docs/api-reference/common/Type/functions/formatTupleError) | - | | [formatUnionError](https://evolu.dev/docs/api-reference/common/Type/functions/formatUnionError) | - | | [idBytesToId](https://evolu.dev/docs/api-reference/common/Type/functions/idBytesToId) | - | | [idToIdBytes](https://evolu.dev/docs/api-reference/common/Type/functions/idToIdBytes) | - | | [isOptionalType](https://evolu.dev/docs/api-reference/common/Type/functions/isOptionalType) | Determines if a given type is an [OptionalType](https://evolu.dev/docs/api-reference/common/Type/interfaces/OptionalType). | | [isUnionType](https://evolu.dev/docs/api-reference/common/Type/functions/isUnionType) | - | | [json](https://evolu.dev/docs/api-reference/common/Type/functions/json) | Creates a branded JSON string [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) and type-safe conversion functions for a given Type. | | [jsonToJsonValue](https://evolu.dev/docs/api-reference/common/Type/functions/jsonToJsonValue) | - | | [jsonValueToJson](https://evolu.dev/docs/api-reference/common/Type/functions/jsonValueToJson) | - | | [optional](https://evolu.dev/docs/api-reference/common/Type/functions/optional) | Optional [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type). | | [parseJson](https://evolu.dev/docs/api-reference/common/Type/functions/parseJson) | - | | [trim](https://evolu.dev/docs/api-reference/common/Type/functions/trim) | - | | [typed](https://evolu.dev/docs/api-reference/common/Type/functions/typed) | Creates a runtime-validated typed object with a `type` discriminant. | ## Interfaces | Interface | Description | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [ArrayError](https://evolu.dev/docs/api-reference/common/Type/interfaces/ArrayError) | - | | [ArrayType](https://evolu.dev/docs/api-reference/common/Type/interfaces/ArrayType) | ArrayType extends Type with an additional `element` property for reflection. | | [Base64UrlError](https://evolu.dev/docs/api-reference/common/Type/interfaces/Base64UrlError) | - | | [BetweenError](https://evolu.dev/docs/api-reference/common/Type/interfaces/BetweenError) | - | | [BigIntError](https://evolu.dev/docs/api-reference/common/Type/interfaces/BigIntError) | - | | [BooleanError](https://evolu.dev/docs/api-reference/common/Type/interfaces/BooleanError) | - | | [BrandType](https://evolu.dev/docs/api-reference/common/Type/interfaces/BrandType) | Evolu [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) is like a type guard that returns typed errors (via [Result](https://evolu.dev/docs/api-reference/common/Result/type-aliases/Result)) instead of throwing. We either receive a safely typed value or a composable typed error that tells us exactly why the validation failed. | | [BrandWithoutRefineError](https://evolu.dev/docs/api-reference/common/Type/interfaces/BrandWithoutRefineError) | - | | [CurrencyCodeError](https://evolu.dev/docs/api-reference/common/Type/interfaces/CurrencyCodeError) | - | | [DateIsoError](https://evolu.dev/docs/api-reference/common/Type/interfaces/DateIsoError) | - | | [EvoluTypeError](https://evolu.dev/docs/api-reference/common/Type/interfaces/EvoluTypeError) | - | | [FiniteError](https://evolu.dev/docs/api-reference/common/Type/interfaces/FiniteError) | - | | [FunctionError](https://evolu.dev/docs/api-reference/common/Type/interfaces/FunctionError) | - | | [GreaterThanError](https://evolu.dev/docs/api-reference/common/Type/interfaces/GreaterThanError) | - | | [GreaterThanOrEqualToError](https://evolu.dev/docs/api-reference/common/Type/interfaces/GreaterThanOrEqualToError) | - | | [IdError](https://evolu.dev/docs/api-reference/common/Type/interfaces/IdError) | - | | [InstanceOfError](https://evolu.dev/docs/api-reference/common/Type/interfaces/InstanceOfError) | - | | [InstanceOfType](https://evolu.dev/docs/api-reference/common/Type/interfaces/InstanceOfType) | Evolu [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) is like a type guard that returns typed errors (via [Result](https://evolu.dev/docs/api-reference/common/Result/type-aliases/Result)) instead of throwing. We either receive a safely typed value or a composable typed error that tells us exactly why the validation failed. | | [Int64Error](https://evolu.dev/docs/api-reference/common/Type/interfaces/Int64Error) | - | | [Int64StringError](https://evolu.dev/docs/api-reference/common/Type/interfaces/Int64StringError) | - | | [IntError](https://evolu.dev/docs/api-reference/common/Type/interfaces/IntError) | - | | [JsonError](https://evolu.dev/docs/api-reference/common/Type/interfaces/JsonError) | - | | [JsonObject](https://evolu.dev/docs/api-reference/common/Type/interfaces/JsonObject) | - | | [JsonObjectInput](https://evolu.dev/docs/api-reference/common/Type/interfaces/JsonObjectInput) | - | | [LengthError](https://evolu.dev/docs/api-reference/common/Type/interfaces/LengthError) | - | | [LessThanError](https://evolu.dev/docs/api-reference/common/Type/interfaces/LessThanError) | - | | [LessThanOrEqualToError](https://evolu.dev/docs/api-reference/common/Type/interfaces/LessThanOrEqualToError) | - | | [LiteralError](https://evolu.dev/docs/api-reference/common/Type/interfaces/LiteralError) | - | | [LiteralType](https://evolu.dev/docs/api-reference/common/Type/interfaces/LiteralType) | Evolu [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) is like a type guard that returns typed errors (via [Result](https://evolu.dev/docs/api-reference/common/Result/type-aliases/Result)) instead of throwing. We either receive a safely typed value or a composable typed error that tells us exactly why the validation failed. | | [MaxLengthError](https://evolu.dev/docs/api-reference/common/Type/interfaces/MaxLengthError) | - | | [MinLengthError](https://evolu.dev/docs/api-reference/common/Type/interfaces/MinLengthError) | - | | [MnemonicError](https://evolu.dev/docs/api-reference/common/Type/interfaces/MnemonicError) | - | | [MultipleOfError](https://evolu.dev/docs/api-reference/common/Type/interfaces/MultipleOfError) | - | | [NameError](https://evolu.dev/docs/api-reference/common/Type/interfaces/NameError) | - | | [NegativeError](https://evolu.dev/docs/api-reference/common/Type/interfaces/NegativeError) | - | | [NonNaNError](https://evolu.dev/docs/api-reference/common/Type/interfaces/NonNaNError) | - | | [NonNegativeError](https://evolu.dev/docs/api-reference/common/Type/interfaces/NonNegativeError) | - | | [NonPositiveError](https://evolu.dev/docs/api-reference/common/Type/interfaces/NonPositiveError) | - | | [NullError](https://evolu.dev/docs/api-reference/common/Type/interfaces/NullError) | - | | [NumberError](https://evolu.dev/docs/api-reference/common/Type/interfaces/NumberError) | - | | [ObjectError](https://evolu.dev/docs/api-reference/common/Type/interfaces/ObjectError) | - | | [ObjectType](https://evolu.dev/docs/api-reference/common/Type/interfaces/ObjectType) | ObjectType extends [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) with an additional `props` property for reflection. | | [ObjectWithRecordError](https://evolu.dev/docs/api-reference/common/Type/interfaces/ObjectWithRecordError) | - | | [ObjectWithRecordType](https://evolu.dev/docs/api-reference/common/Type/interfaces/ObjectWithRecordType) | ObjectWithRecordType extends [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) with additional `props` and `record` properties for reflection. | | [OptionalType](https://evolu.dev/docs/api-reference/common/Type/interfaces/OptionalType) | Evolu [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) is like a type guard that returns typed errors (via [Result](https://evolu.dev/docs/api-reference/common/Result/type-aliases/Result)) instead of throwing. We either receive a safely typed value or a composable typed error that tells us exactly why the validation failed. | | [PositiveError](https://evolu.dev/docs/api-reference/common/Type/interfaces/PositiveError) | - | | [RecordError](https://evolu.dev/docs/api-reference/common/Type/interfaces/RecordError) | - | | [RecordType](https://evolu.dev/docs/api-reference/common/Type/interfaces/RecordType) | RecordType extends [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) with additional `key` and `value` properties for reflection. | | [RecursiveType](https://evolu.dev/docs/api-reference/common/Type/interfaces/RecursiveType) | Evolu [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) is like a type guard that returns typed errors (via [Result](https://evolu.dev/docs/api-reference/common/Result/type-aliases/Result)) instead of throwing. We either receive a safely typed value or a composable typed error that tells us exactly why the validation failed. | | [RegexError](https://evolu.dev/docs/api-reference/common/Type/interfaces/RegexError) | - | | [SetError](https://evolu.dev/docs/api-reference/common/Type/interfaces/SetError) | - | | [SetType](https://evolu.dev/docs/api-reference/common/Type/interfaces/SetType) | SetType extends Type with an additional `element` property for reflection. | | [StandardSchemaV1](https://evolu.dev/docs/api-reference/common/Type/interfaces/StandardSchemaV1) | The Standard Schema interface. | | [StringError](https://evolu.dev/docs/api-reference/common/Type/interfaces/StringError) | - | | [TableId](https://evolu.dev/docs/api-reference/common/Type/interfaces/TableId) | Evolu [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) is like a type guard that returns typed errors (via [Result](https://evolu.dev/docs/api-reference/common/Result/type-aliases/Result)) instead of throwing. We either receive a safely typed value or a composable typed error that tells us exactly why the validation failed. | | [TableIdError](https://evolu.dev/docs/api-reference/common/Type/interfaces/TableIdError) | - | | [TrimmedError](https://evolu.dev/docs/api-reference/common/Type/interfaces/TrimmedError) | - | | [TupleError](https://evolu.dev/docs/api-reference/common/Type/interfaces/TupleError) | - | | [TupleType](https://evolu.dev/docs/api-reference/common/Type/interfaces/TupleType) | TupleType extends [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) with an additional `elements` property for reflection. | | [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) | Evolu [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) is like a type guard that returns typed errors (via [Result](https://evolu.dev/docs/api-reference/common/Result/type-aliases/Result)) instead of throwing. We either receive a safely typed value or a composable typed error that tells us exactly why the validation failed. | | [Typed](https://evolu.dev/docs/api-reference/common/Type/interfaces/Typed) | Base interface for objects with a discriminant `type` property. | | [TypeError](https://evolu.dev/docs/api-reference/common/Type/interfaces/TypeError) | - | | [TypeErrorWithReason](https://evolu.dev/docs/api-reference/common/Type/interfaces/TypeErrorWithReason) | - | | [Uint8ArrayError](https://evolu.dev/docs/api-reference/common/Type/interfaces/Uint8ArrayError) | - | | [UndefinedError](https://evolu.dev/docs/api-reference/common/Type/interfaces/UndefinedError) | - | | [UnionError](https://evolu.dev/docs/api-reference/common/Type/interfaces/UnionError) | - | | [UnionType](https://evolu.dev/docs/api-reference/common/Type/interfaces/UnionType) | UnionType extends [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) with an additional `members` property for reflection. | ## Namespaces | Namespace | Description | | ---------------------------------------------------------------------------------------- | ----------- | | [StandardSchemaV1](https://evolu.dev/docs/api-reference/common/Type/namespaces/StandardSchemaV1) | - | ## Type Aliases | Type Alias | Description | | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | [IdBytes](https://evolu.dev/docs/api-reference/common/Type/type-aliases/IdBytes) | Binary representation of an [Id](https://evolu.dev/docs/api-reference/common/Type/variables/Id). | | [IsUnionWithNull](https://evolu.dev/docs/api-reference/common/Type/type-aliases/IsUnionWithNull) | - | | [JsonArrayInput](https://evolu.dev/docs/api-reference/common/Type/type-aliases/JsonArrayInput) | - | | [JsonValue](https://evolu.dev/docs/api-reference/common/Type/type-aliases/JsonValue) | Validated JSON-compatible value. | | [JsonValueError](https://evolu.dev/docs/api-reference/common/Type/type-aliases/JsonValueError) | - | | [JsonValueInput](https://evolu.dev/docs/api-reference/common/Type/type-aliases/JsonValueInput) | JSON-compatible input value before validation. | | [NullableToOptionalProps](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NullableToOptionalProps) | - | | [NullTypeInMembers](https://evolu.dev/docs/api-reference/common/Type/type-aliases/NullTypeInMembers) | - | | [SimplePasswordError](https://evolu.dev/docs/api-reference/common/Type/type-aliases/SimplePasswordError) | - | | [TransformNullable](https://evolu.dev/docs/api-reference/common/Type/type-aliases/TransformNullable) | - | | [TypedType](https://evolu.dev/docs/api-reference/common/Type/type-aliases/TypedType) | Return type of [typed](https://evolu.dev/docs/api-reference/common/Type/functions/typed). | | [TypeErrorFormatter](https://evolu.dev/docs/api-reference/common/Type/type-aliases/TypeErrorFormatter) | - | | [UrlSafeStringError](https://evolu.dev/docs/api-reference/common/Type/type-aliases/UrlSafeStringError) | - | ## Variables | Variable | Description | | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | [base64UrlToUint8Array](https://evolu.dev/docs/api-reference/common/Type/variables/base64UrlToUint8Array) | Decodes a [Base64Url](https://evolu.dev/docs/api-reference/common/Type/variables/Base64Url) string to a Uint8Array. | | [EvoluType](https://evolu.dev/docs/api-reference/common/Type/variables/EvoluType) | Validates that an unknown value is an Evolu [Type](https://evolu.dev/docs/api-reference/common/Type/interfaces/Type) (i.e., satisfies `AnyType`). | | [formatBase64UrlError](https://evolu.dev/docs/api-reference/common/Type/variables/formatBase64UrlError) | - | | [formatBetweenError](https://evolu.dev/docs/api-reference/common/Type/variables/formatBetweenError) | - | | [formatBigIntError](https://evolu.dev/docs/api-reference/common/Type/variables/formatBigIntError) | - | | [formatBooleanError](https://evolu.dev/docs/api-reference/common/Type/variables/formatBooleanError) | - | | [formatCurrencyCodeError](https://evolu.dev/docs/api-reference/common/Type/variables/formatCurrencyCodeError) | - | | [formatDateIsoError](https://evolu.dev/docs/api-reference/common/Type/variables/formatDateIsoError) | - | | [formatFiniteError](https://evolu.dev/docs/api-reference/common/Type/variables/formatFiniteError) | - | | [formatFunctionError](https://evolu.dev/docs/api-reference/common/Type/variables/formatFunctionError) | - | | [formatGreaterThanError](https://evolu.dev/docs/api-reference/common/Type/variables/formatGreaterThanError) | - | | [formatGreaterThanOrEqualToError](https://evolu.dev/docs/api-reference/common/Type/variables/formatGreaterThanOrEqualToError) | - | | [formatIdError](https://evolu.dev/docs/api-reference/common/Type/variables/formatIdError) | - | | [formatInstanceOfError](https://evolu.dev/docs/api-reference/common/Type/variables/formatInstanceOfError) | - | | [formatInt64Error](https://evolu.dev/docs/api-reference/common/Type/variables/formatInt64Error) | - | | [formatInt64StringError](https://evolu.dev/docs/api-reference/common/Type/variables/formatInt64StringError) | - | | [formatIntError](https://evolu.dev/docs/api-reference/common/Type/variables/formatIntError) | - | | [formatIsTypeError](https://evolu.dev/docs/api-reference/common/Type/variables/formatIsTypeError) | - | | [formatJsonError](https://evolu.dev/docs/api-reference/common/Type/variables/formatJsonError) | - | | [formatLengthError](https://evolu.dev/docs/api-reference/common/Type/variables/formatLengthError) | - | | [formatLessThanError](https://evolu.dev/docs/api-reference/common/Type/variables/formatLessThanError) | - | | [formatLessThanOrEqualToError](https://evolu.dev/docs/api-reference/common/Type/variables/formatLessThanOrEqualToError) | - | | [formatLiteralError](https://evolu.dev/docs/api-reference/common/Type/variables/formatLiteralError) | - | | [formatMaxLengthError](https://evolu.dev/docs/api-reference/common/Type/variables/formatMaxLengthError) | - | | [formatMinLengthError](https://evolu.dev/docs/api-reference/common/Type/variables/formatMinLengthError) | - | | [formatMnemonicError](https://evolu.dev/docs/api-reference/common/Type/variables/formatMnemonicError) | - | | [formatMultipleOfError](https://evolu.dev/docs/api-reference/common/Type/variables/formatMultipleOfError) | - | | [formatNegativeError](https://evolu.dev/docs/api-reference/common/Type/variables/formatNegativeError) | - | | [formatNonNaNError](https://evolu.dev/docs/api-reference/common/Type/variables/formatNonNaNError) | - | | [formatNonNegativeError](https://evolu.dev/docs/api-reference/common/Type/variables/formatNonNegativeError) | - | | [formatNonPositiveError](https://evolu.dev/docs/api-reference/common/Type/variables/formatNonPositiveError) | - | | [formatNullError](https://evolu.dev/docs/api-reference/common/Type/variables/formatNullError) | - | | [formatNumberError](https://evolu.dev/docs/api-reference/common/Type/variables/formatNumberError) | - | | [formatPositiveError](https://evolu.dev/docs/api-reference/common/Type/variables/formatPositiveError) | - | | [formatRegexError](https://evolu.dev/docs/api-reference/common/Type/variables/formatRegexError) | - | | [formatStringError](https://evolu.dev/docs/api-reference/common/Type/variables/formatStringError) | - | | [formatTableIdError](https://evolu.dev/docs/api-reference/common/Type/variables/formatTableIdError) | - | | [formatTrimmedError](https://evolu.dev/docs/api-reference/common/Type/variables/formatTrimmedError) | - | | [formatUint8ArrayError](https://evolu.dev/docs/api-reference/common/Type/variables/formatUint8ArrayError) | - | | [formatUndefinedError](https://evolu.dev/docs/api-reference/common/Type/variables/formatUndefinedError) | - | | [IdBytes](https://evolu.dev/docs/api-reference/common/Type/variables/IdBytes) | Binary representation of an [Id](https://evolu.dev/docs/api-reference/common/Type/variables/Id). | | [idBytesTypeValueLength](https://evolu.dev/docs/api-reference/common/Type/variables/idBytesTypeValueLength) | - | | [maxPositiveInt](https://evolu.dev/docs/api-reference/common/Type/variables/maxPositiveInt) | Maximum [PositiveInt](https://evolu.dev/docs/api-reference/common/Type/variables/PositiveInt) value (MAX_SAFE_INTEGER). | | [onePositiveInt](https://evolu.dev/docs/api-reference/common/Type/variables/onePositiveInt) | [PositiveInt](https://evolu.dev/docs/api-reference/common/Type/variables/PositiveInt) value 1. | | [testName](https://evolu.dev/docs/api-reference/common/Type/variables/testName) | - | | [uint8ArrayToBase64Url](https://evolu.dev/docs/api-reference/common/Type/variables/uint8ArrayToBase64Url) | Encodes a Uint8Array to a [Base64Url](https://evolu.dev/docs/api-reference/common/Type/variables/Base64Url) string. | | [zeroNonNegativeInt](https://evolu.dev/docs/api-reference/common/Type/variables/zeroNonNegativeInt) | Minimum [NonNegativeInt](https://evolu.dev/docs/api-reference/common/Type/variables/NonNegativeInt) value (0). |