Class TypeInformation<T, U>`Abstract`

Type Parameters

T
U = undefined

Hierarchy

TypeInformation

Index

Constructors

Accessors

Methods

__registerType check checkError exportToJson exportToString importFromJson importFromString json sendableVia

Constructors

constructor

new TypeInformation<T, U>(): TypeInformation<T, U>
Type Parameters
- T
- U = undefined
Returns TypeInformation<T, U>
- Defined in packages/core/types/src/types.ts:46

Accessors

`Abstract` identifier

get identifier(): string
Returns string
- Defined in packages/core/types/src/types.ts:87

Methods

`Private` __registerType

__registerType(): void
Returns void
- Defined in packages/core/types/src/types.ts:51

`Abstract` check

check<V>(value): U extends any
? boolean
: Extends<V, T>
Checks if the given value is of the type defined by this type information
Type Parameters
- V
Parameters
- value: V
  The value to check
Returns U extends any
? boolean
: Extends<V, T>
- Defined in packages/core/types/src/types.ts:66

`Abstract` checkError

checkError(value): undefined | string
Returns the check-error for the given value
Parameters
- value: unknown
  The value to check
Returns undefined | string
The error if the value is not of the type defined by this type information
- Defined in packages/core/types/src/types.ts:73

`Abstract` exportToJson

exportToJson(value): JsonCompatible
Parameters
- value: T
Returns JsonCompatible
- Defined in packages/core/types/src/types.ts:90

`Abstract` exportToString

exportToString(value): string
Parameters
- value: T
Returns string
- Defined in packages/core/types/src/types.ts:88

`Abstract` importFromJson

importFromJson(value): T
Parameters
- value: JsonCompatible
Returns T
- Defined in packages/core/types/src/types.ts:91

`Abstract` importFromString

importFromString(value): T
Parameters
- value: string
Returns T
- Defined in packages/core/types/src/types.ts:89

`Abstract` json

json(): unknown
Returns unknown
- Defined in packages/core/types/src/types.ts:93

`Abstract` sendableVia

sendableVia(): SendMethod[]
Get a list of methods that can be used to send this type to the server

Returns SendMethod[]
- Defined in packages/core/types/src/types.ts:78
sendableVia(m): boolean
Checks if the given method can be used to send this type to the server
Parameters
- m: SendMethod
  The method to check
Returns boolean
- Defined in packages/core/types/src/types.ts:85

Generated using TypeDoc