types.md

generate-runtypes / types

Module: types

Table of contents

Type aliases

• AnyType
• ArrayType
• DictionaryType
• IntersectionType
• LiteralType
• NamedType
• RecordField
• RecordType
• RootType
• SimpleType
• UnionType

Variables

• rootTypeRt

Type aliases

AnyType

Ƭ AnyType: rt.Static<typeof anyTypeRt>

Defined in: src/types.ts:162

---

ArrayType

Ƭ ArrayType: object

Type declaration

Name	Type
kind	"array"
readonly?	boolean
type	AnyType

Defined in: src/types.ts:78

---

DictionaryType

Ƭ DictionaryType: object

Type declaration

Name	Type
kind	"dictionary"
valueType	AnyType

Defined in: src/types.ts:95

---

IntersectionType

Ƭ IntersectionType: object

Type declaration

Name	Type
kind	"intersect"
types	AnyType[]

Defined in: src/types.ts:130

---

LiteralType

Ƭ LiteralType: rt.Static<typeof literalTypeRt>

Defined in: src/types.ts:32

---

NamedType

Ƭ NamedType: rt.Static<typeof namedTypeRt>

Defined in: src/types.ts:46

---

RecordField

Ƭ RecordField: object

Type declaration

Name	Type
comment?	string | string[]
name	string
nullable?	boolean
readonly?	boolean
type	AnyType

Defined in: src/types.ts:48

---

RecordType

Ƭ RecordType: object

Type declaration

Name	Type
fields	RecordField[]
kind	"record"

Defined in: src/types.ts:56

---

RootType

Ƭ RootType: rt.Static<typeof rootTypeRt>

Defined in: src/types.ts:174

---

SimpleType

Ƭ SimpleType: rt.Static<typeof simpleTypeRt>

Defined in: src/types.ts:21

---

UnionType

Ƭ UnionType: object

Type declaration

Name	Type
kind	"union"
types	AnyType[]

Defined in: src/types.ts:110

Variables

rootTypeRt

• Const rootTypeRt: Intersect<[Record<{ name: String ; type: Union<[Runtype<ArrayType>, Runtype<DictionaryType>, Runtype<IntersectionType>, Record<{ kind: Literal<"literal"> ; value: Union<[Boolean, Literal<null>, Number, String, Literal<undefined>]> }, false>, Record<{ kind: Literal<"named"> ; name: String }, false>, Runtype<RecordType>, Record<{ kind: Union<[Literal<"boolean">, Literal<"function">, Literal<"never">, Literal<"null">, Literal<"number">, Literal<"string">, Literal<"symbol">, Literal<"undefined">, Literal<"unknown">]> }, false>, Runtype<UnionType>]> }, false>, InternalRecord<{ comment: Union<[String, Arr<String, false>]> ; export: Boolean }, true, false>]>

Defined in: src/types.ts:164