API reference / @evolu/common / Type / IdType

Interface: IdType<Table>

Defined in: packages/common/src/Type.ts:1439

Extends

Type Parameters

Type Parameter
Table extends TypeName

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
[EvoluTypeSymbol]readonlytrue-Type.[EvoluTypeSymbol]packages/common/src/Type.ts:167
ErrorpublicIdError<Table>The specific error introduced by this Type. ### Example type StringError = typeof String.Error;Type.Errorpackages/common/src/Type.ts:92
Errorsreadonly| StringError | IdError<Table>ErrorParentError ### Example type StringParentErrors = typeof String.Errors;Type.Errors
fromreadonly(value) => Result<string & Brand<"Id"> & Brand<Table>, | StringError | IdError<Table>>Creates T from an Input value. This is useful when we have a typed value. from is a typed alias of fromUnknown.Type.frompackages/common/src/Type.ts:107
fromParentreadonly(value) => Result<string & Brand<"Id"> & Brand<Table>, IdError<Table>>Creates T from Parent type. This function skips parent Types validations/transformations when we have already partially validated/transformed value. For example, TrimString.from checks whether a value is a string and trims it. If we only want to trim a string, we can use fromParent. ### Example // string & Brand<"Trimmed"> const value = TrimString.fromParent("a ").value; // as efficient as foo.trim()Type.fromParentpackages/common/src/Type.ts:141
fromUnknownreadonly(value) => Result<string & Brand<"Id"> & Brand<Table>, | StringError | IdError<Table>>Creates T from an unknown value. This is useful when a value is unknown.Type.fromUnknownpackages/common/src/Type.ts:114
InputpublicstringThe type expected by from and fromUnknown. ### Example type StringInput = typeof String.Input;Type.Inputpackages/common/src/Type.ts:90
isreadonly(value) => value is string & Brand<"Id"> & Brand<Table>A type guard that checks whether an unknown value satisfies the Type. ### Example const value: unknown = "hello"; if (String.is(value)) { // TypeScript now knows valueis astring here. console.log("This is a valid string!"); } const strings: unknown[] = [1, "hello", true, "world"]; const filteredStrings = strings.filter(String.is); console.log(filteredStrings); // ["hello", "world"]Type.ispackages/common/src/Type.ts:165
namereadonly"Id"-Type.namepackages/common/src/Type.ts:98
ParentpublicstringThe parent type. ### Example type StringParent = typeof String.Parent;Type.Parentpackages/common/src/Type.ts:94
ParentErrorpublicStringErrorThe parent's error. ### Example type StringParentError = typeof String.ParentError;Type.ParentErrorpackages/common/src/Type.ts:96
tablepublicTable--packages/common/src/Type.ts:1448
toreadonly(value) => stringThe opposite of from and fromUnknown. This is useful to transform T back to its Input representation. For refine, it only removes the brand. For transform, it changes value.Type.topackages/common/src/Type.ts:123
toParentreadonly(value) => stringThe opposite of fromParent.Type.toParentpackages/common/src/Type.ts:144
Typereadonlystring & Brand<"Id"> & Brand<Table>The type this Type resolves to. ### Example type String = typeof String.Type;Type.Typepackages/common/src/Type.ts:178

Was this page helpful?