Search
Preparing search index...
The search index is not available
Kryo
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"types/tagged-union"
TaggedUnionType
Class TaggedUnionType<T, K>
Type parameters
T
K
:
DocumentType
<
T
>
Hierarchy
TaggedUnionType
Implements
IoType
<
T
>
TaggedUnionTypeOptions
<
T
,
K
>
Index
Constructors
constructor
Properties
_options
_out
Tag
_tag
Type
_value
ToVariant
Map
name
tag
variants
Methods
_apply
Options
clone
equals
get
Out
Tag
get
Tag
Type
get
Value
ToVariant
Map
match
match
Trusted
read
test
test
Error
variant
Read
write
Constructors
constructor
new
Tagged
Union
Type
(
options
:
Lazy
<
TaggedUnionTypeOptions
<
T
,
K
>
>
)
:
TaggedUnionType
Parameters
options:
Lazy
<
TaggedUnionTypeOptions
<
T
,
K
>
>
Returns
TaggedUnionType
Properties
Private
Optional
_options
_options
:
Lazy
<
TaggedUnionTypeOptions
<
T
,
K
>
>
Private
_out
Tag
_out
Tag
:
string
|
undefined
Private
_tag
Type
_tag
Type
:
TsEnumType
<
any
>
|
undefined
Private
_value
ToVariant
Map
_value
ToVariant
Map
:
Map
<
any
,
K
>
|
undefined
name
name
:
Name
= name
tag
tag
:
keyof T
variants
variants
:
ReadonlyArray
<
K
>
Methods
Private
_apply
Options
_apply
Options
(
)
:
void
Returns
void
clone
clone
(
val
:
T
)
:
T
Parameters
val:
T
Returns
T
equals
equals
(
val1
:
T
, val2
:
T
)
:
boolean
Parameters
val1:
T
val2:
T
Returns
boolean
Private
get
Out
Tag
get
Out
Tag
(
)
:
string
Returns the serialized name of the tag property
Returns
string
Private
get
Tag
Type
get
Tag
Type
(
)
:
TsEnumType
<
any
>
Returns
TsEnumType
<
any
>
Private
get
Value
ToVariant
Map
get
Value
ToVariant
Map
(
)
:
Map
<
any
,
K
>
Returns
Map
<
any
,
K
>
match
match
(
value
:
T
)
:
K
|
undefined
Parameters
value:
T
Returns
K
|
undefined
match
Trusted
match
Trusted
(
value
:
T
)
:
K
Parameters
value:
T
Returns
K
read
read<R>
(
reader
:
Reader
<
R
>
, raw
:
R
)
:
T
Type parameters
R
Parameters
reader:
Reader
<
R
>
raw:
R
Returns
T
test
test
(
value
:
T
)
:
boolean
Parameters
value:
T
Returns
boolean
test
Error
test
Error
(
value
:
T
)
:
Error
|
undefined
Parameters
value:
T
Returns
Error
|
undefined
variant
Read
variant
Read<R>
(
reader
:
Reader
<
R
>
, raw
:
R
)
:
[
K
,
T
]
Type parameters
R
Parameters
reader:
Reader
<
R
>
raw:
R
Returns
[
K
,
T
]
write
write<W>
(
writer
:
Writer
<
W
>
, value
:
T
)
:
W
Type parameters
W
Parameters
writer:
Writer
<
W
>
value:
T
Returns
W
Globals
"types/tagged-
union"
Tagged
Union
Type
constructor
_options
_out
Tag
_tag
Type
_value
ToVariant
Map
name
tag
variants
_apply
Options
clone
equals
get
Out
Tag
get
Tag
Type
get
Value
ToVariant
Map
match
match
Trusted
read
test
test
Error
variant
Read
write
Tagged
Union
Type
Options
Diff
Name
Test
With
Variant
Result
name
Generated using
TypeDoc
Returns the serialized name of the tag property