API reference › @evolu/common › Types

TypeScript utility types.

Functions

Function	Description
instance	Creates the runtime identity property required by Instance.
isInstance	Creates a realm-neutral predicate for one Instance name.
isPromiseLike	Type guard to check if a value is a PromiseLike.

Interfaces

Interface	Description
Instance	Realm-neutral runtime identity for a TypeScript interface.
ValueWithLength	A value with a numeric length.

Type Aliases

Type Alias	Description
Awaitable	A value that can be awaited.
Callback	A function that receives a value and returns nothing.
CallbackWithTeardown	A function that receives a value and optionally returns a teardown function.
CompileTimeError	Creates a readable compiler-facing error message.
DistributiveOmit	Removes keys from each member of a union.
IsSameType	Returns whether two types are identical according to TypeScript.
IsUnion	Returns whether a type is a union.
KeysOfUnion	Returns every property key present in any member of a union.
Literal	String, number, bigint, boolean, undefined, null
NullablePartial	Makes properties optional if they accept null as a value.
ParameterIntersection	Intersects the parameter types of a union of unary functions.
PartialProp	Makes a specific property of an object optional while keeping others unchanged.
Predicate	Checks a condition on a value and returns a boolean.
PredicateWithIndex	Checks a condition on a value at a given index and returns a boolean.
Refinement	A type guard function that refines type A to a narrower type B.
RefinementWithIndex	A type guard function that refines type A to a narrower type B at a given index.
Simplify	Simplify an intersection type into a single mapped type.
UnionToIntersection	Converts a union to an intersection.
WidenLiteral	Infers a broader type from a specific literal value type.
Writable	Removes readonly modifier from all properties of a type.