Class TryUnionType<T, M>

Type parameters

T
M: Type<T>

Hierarchy

TryUnionType

Implements

IoType<T>
TryUnionTypeOptions<T, M>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TryUnionType(options: Lazy<TryUnionTypeOptions<T, M>>): TryUnionType

- Defined in types/try-union.ts:28
Parameters
- options: Lazy<TryUnionTypeOptions<T, M>>
Returns TryUnionType

Properties

Private Optional _options

_options: Lazy<TryUnionTypeOptions<T, M>>

name

name: Name = name

variants

variants: M[]

Methods

Private _applyOptions

_applyOptions(): void

- Defined in types/try-union.ts:110
Returns void

clone

clone(val: T): T

Implementation of IoType.clone
- Defined in types/try-union.ts:106
Parameters
- val: T
Returns T

equals

equals(val1: T, val2: T): boolean

Implementation of IoType.equals
- Defined in types/try-union.ts:100
Parameters
- val1: T
- val2: T
Returns boolean

match

match(value: T): M | undefined

- Defined in types/try-union.ts:43
Parameters
- value: T
Returns M | undefined

matchTrusted

matchTrusted(value: T): M

- Defined in types/try-union.ts:52
Parameters
- value: T
Returns M

read

read<R>(reader: Reader<R>, raw: R): T

Implementation of IoType.read
- Defined in types/try-union.ts:67
Type parameters
- R
Parameters
- reader: Reader<R>
- raw: R
Returns T

test

test(val: T): boolean

Implementation of IoType.test
- Defined in types/try-union.ts:91
Parameters
- val: T
Returns boolean

testError

testError(value: T): Error | undefined

Implementation of IoType.testError
- Defined in types/try-union.ts:83
Parameters
- value: T
Returns Error | undefined

variantRead

variantRead<R>(reader: Reader<R>, raw: R): VariantValue<T, M>

- Defined in types/try-union.ts:71
Type parameters
- R
Parameters
- reader: Reader<R>
- raw: R
Returns VariantValue<T, M>

write

write<W>(writer: Writer<W>, value: T): W

Implementation of IoType.write
- Defined in types/try-union.ts:56
Type parameters
- W
Parameters
- writer: Writer<W>
- value: T
Returns W

Generated using TypeDoc