Prerequisite: Read the Deepkit section about Type Annotations.

ID

The ID type is represented as a ID scalar.

ID is exported from @deepkit-graphql/core

MongoID

The MongoID type is represented as a ObjectID scalar.

MongoID is exported from @deepkit/type

UUID

The UUID type is represented as a UUID scalar.

UUID is exported from @deepkit/type

Array

The Array type is represented as a List.

Date

The Date type is serialized as an ISO 8601 formatted string, and represented as a DateTime scalar.

An ISO 8601 formatted string looks like 2007-12-03T10:15:30Z

string

The string type is represented as a String scalar.

boolean

The boolean type is is represented as a Boolean scalar.

float

The float type is represented as a Float scalar.

float is exported from @deepkit/type

Annotations

Positive

The Positive annotation for float is represented as a PositiveFloat scalar.

Positive is exported from @deepkit/type

Negative

The Negative annotation for float is represented as a NegativeFloat scalar.

Negative is exported from @deepkit/type

number

The number type is not a valid type, because it cannot be represented.

integer

The integer type is represented as a Int scalar.

integer is exported from @deepkit/type

Annotations

Positive

The Positive annotation for integer is represented as a PositiveInt scalar.

Positive is exported from @deepkit/type

Negative

The Negative annotation for integer is represented as a NegativeInt scalar.

Negative is exported from @deepkit/type

bigint

The bigint type is represented as a BigInt scalar.

Annotations

BinaryBigInt

The BinaryBigInt type is represented as a BinaryBigInt scalar.

BinaryBigInt is exported from @deepkit/type

SignedBinaryBigInt

The SignedBinaryBigInt type is represented as a SignedBinaryBigInt scalar.

SignedBinaryBigInt is exported from @deepkit/type

ArrayBuffer

The ArrayBuffer type is represented as a Byte scalar.

Uint8Array

The Uint8Array type is represented as a Byte scalar.