Preparing search index...
The search index is not available
XYO Platform SDK - v3.6.9
XYO Platform SDK
@xyo-network/sdk-utils
PayloadPluginResolver
Class PayloadPluginResolver
Index
Constructors
constructor
Properties
_plugins
default
Plugin
schema
Methods
plugins
register
resolve
schemas
validate
wrap
Constructors
constructor
new
PayloadPluginResolver
(
plugins
?:
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
[]
,
defaultPlugin
?:
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
,
)
:
PayloadPluginResolver
Parameters
Optional
plugins
:
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
[]
Optional
defaultPlugin
:
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
Returns
PayloadPluginResolver
Properties
Protected
_plugins
_plugins
:
Record
<
string
,
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
,
>
Protected
default
Plugin
defaultPlugin
:
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
schema
schema
:
"network.xyo.payload"
Methods
plugins
plugins
()
:
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
[]
Returns
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
[]
register
register
<
TPlugin
extends
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
=
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
,
>
,
>
(
plugin
:
TPlugin
,
)
:
this
Type Parameters
TPlugin
extends
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
=
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
Parameters
plugin
:
TPlugin
Returns
this
resolve
resolve
(
schema
?:
string
,
)
:
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
Parameters
Optional
schema
:
string
Returns
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
resolve
(
payload
:
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
,
)
:
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
Parameters
payload
:
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
Returns
PayloadPlugin
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
schemas
schemas
()
:
string
[]
Returns
string
[]
validate
validate
(
payload
:
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
,
)
:
undefined
|
Validator
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
Parameters
payload
:
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
Returns
undefined
|
Validator
<
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
>
wrap
wrap
(
payload
:
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
,
)
:
undefined
|
PayloadWrapper
Parameters
payload
:
DeepRestrictToStringKeys
<
{
schema
:
string
}
>
Returns
undefined
|
PayloadWrapper
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
_plugins
default
Plugin
schema
Methods
plugins
register
resolve
schemas
validate
wrap
XYO Platform SDK - v3.6.9
Loading...