XYO Platform SDK - v3.10.6
Preparing search index...
@xyo-network/protocol
PayloadWrapperBase
Class PayloadWrapperBase<TPayload>
Type Parameters
TPayload
extends
Payload
=
Payload
Hierarchy (
View Summary
)
PayloadWrapperBase
BoundWitnessWrapper
Index
Constructors
constructor
Properties
payload
Methods
data
Hash
get
Errors
get
Valid
schema
validate
unwrap
unwrap
Single
Payload
Constructors
Protected
constructor
new
PayloadWrapperBase
<
TPayload
extends
Payload
=
Payload
>
(
payload
:
TPayload
,
)
:
PayloadWrapperBase
<
TPayload
>
Type Parameters
TPayload
extends
Payload
=
Payload
Parameters
payload
:
TPayload
Returns
PayloadWrapperBase
<
TPayload
>
Properties
payload
payload
:
TPayload
Methods
data
Hash
dataHash
()
:
Promise
<
Lowercase
<
string
>
>
Returns
Promise
<
Lowercase
<
string
>
>
get
Errors
getErrors
()
:
Promise
<
Error
[]
>
Returns
Promise
<
Error
[]
>
get
Valid
getValid
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
schema
schema
()
:
string
Returns
string
validate
validate
()
:
Promisable
<
Error
[]
>
Returns
Promisable
<
Error
[]
>
Static
unwrap
unwrap
<
TPayload
extends
Payload
=
Payload
>
(
payload
?:
TPayload
,
)
:
undefined
|
TPayload
Type Parameters
TPayload
extends
Payload
=
Payload
Parameters
Optional
payload
:
TPayload
Returns
undefined
|
TPayload
unwrap
<
TPayload
extends
Payload
=
Payload
,
TWrapper
extends
PayloadWrapperBase
<
TPayload
>
=
PayloadWrapperBase
<
TPayload
>
,
>
(
payload
:
TPayload
|
TWrapper
,
)
:
TPayload
Type Parameters
TPayload
extends
Payload
=
Payload
TWrapper
extends
PayloadWrapperBase
<
TPayload
>
=
PayloadWrapperBase
<
TPayload
>
Parameters
payload
:
TPayload
|
TWrapper
Returns
TPayload
unwrap
<
TPayload
extends
Payload
=
Payload
,
TWrapper
extends
PayloadWrapperBase
<
TPayload
>
=
PayloadWrapperBase
<
TPayload
>
,
>
(
payload
:
(
TPayload
|
TWrapper
)
[]
,
)
:
TPayload
[]
Type Parameters
TPayload
extends
Payload
=
Payload
TWrapper
extends
PayloadWrapperBase
<
TPayload
>
=
PayloadWrapperBase
<
TPayload
>
Parameters
payload
: (
TPayload
|
TWrapper
)
[]
Returns
TPayload
[]
Static
unwrap
Single
Payload
unwrapSinglePayload
<
TPayload
extends
Payload
=
Payload
>
(
payload
?:
TPayload
,
)
:
undefined
|
TPayload
Type Parameters
TPayload
extends
Payload
=
Payload
Parameters
Optional
payload
:
TPayload
Returns
undefined
|
TPayload
unwrapSinglePayload
<
TPayload
extends
Payload
=
Payload
,
TWrapper
extends
PayloadWrapperBase
<
TPayload
>
=
PayloadWrapperBase
<
TPayload
>
,
>
(
payload
:
TPayload
|
TWrapper
,
)
:
TPayload
Type Parameters
TPayload
extends
Payload
=
Payload
TWrapper
extends
PayloadWrapperBase
<
TPayload
>
=
PayloadWrapperBase
<
TPayload
>
Parameters
payload
:
TPayload
|
TWrapper
Returns
TPayload
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
payload
Methods
data
Hash
get
Errors
get
Valid
schema
validate
unwrap
unwrap
Single
Payload
XYO Platform SDK - v3.10.6
Loading...