Skip to main content

TypeScript SDK Reference

api/client.gen.TypeDefKind

Distinguishes the different kinds of TypeDefs.

Enumeration Members​

BooleanKind​

BooleanKind = "BOOLEAN_KIND"

A boolean value.

EnumKind​

EnumKind = "ENUM_KIND"

A GraphQL enum type and its values

Always paired with an EnumTypeDef.

InputKind​

InputKind = "INPUT_KIND"

A graphql input type, used only when representing the core API via TypeDefs.

IntegerKind​

IntegerKind = "INTEGER_KIND"

An integer value.

InterfaceKind​

InterfaceKind = "INTERFACE_KIND"

A named type of functions that can be matched+implemented by other objects+interfaces.

Always paired with an InterfaceTypeDef.

ListKind​

ListKind = "LIST_KIND"

A list of values all having the same type.

Always paired with a ListTypeDef.

ObjectKind​

ObjectKind = "OBJECT_KIND"

A named type defined in the GraphQL schema, with fields and functions.

Always paired with an ObjectTypeDef.

ScalarKind​

ScalarKind = "SCALAR_KIND"

A scalar value of any basic kind.

StringKind​

StringKind = "STRING_KIND"

A string value.

VoidKind​

VoidKind = "VOID_KIND"

A special kind used to signify that no value is returned.

This is used for functions that have no return value. The outer TypeDef specifying this Kind is always Optional, as the Void is never actually represented.