Preparing search index...
The search index is not available
XYO Platform SDK - v3.9.16
XYO Platform SDK
@xyo-network/modules
SentinelIntervalAutomationWrapper
Class SentinelIntervalAutomationWrapper<T>
Type Parameters
T
extends
SentinelIntervalAutomationPayload
=
SentinelIntervalAutomationPayload
Hierarchy (
View Summary
)
PayloadWrapper
<
T
>
SentinelIntervalAutomationWrapper
Index
Constructors
constructor
Properties
payload
loader
Factory
Accessors
frequency
Millis
remaining
Methods
check
End
consume
Remaining
data
Hash
get
Errors
get
Valid
next
schema
set
Remaining
set
Start
validate
as
load
parse
set
Loader
Factory
try
Parse
unwrap
unwrap
Single
Payload
wrap
wrapped
Map
Constructors
constructor
new
SentinelIntervalAutomationWrapper
<
T
extends
SentinelIntervalAutomationPayload
=
SentinelIntervalAutomationPayload
,
>
(
payload
:
T
,
)
:
SentinelIntervalAutomationWrapper
<
T
>
Type Parameters
T
extends
SentinelIntervalAutomationPayload
=
SentinelIntervalAutomationPayload
Parameters
payload
:
T
Returns
SentinelIntervalAutomationWrapper
<
T
>
Properties
payload
payload
:
T
Protected
Static
loader
Factory
loaderFactory
:
null
|
PayloadLoaderFactory
Accessors
Protected
frequency
Millis
get
frequencyMillis
()
:
number
Returns
number
Protected
remaining
get
remaining
()
:
number
Returns
number
Methods
Protected
check
End
checkEnd
()
:
void
Returns
void
Protected
consume
Remaining
consumeRemaining
(
count
?:
number
)
:
void
Parameters
Optional
count
:
number
Returns
void
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
>
next
next
()
:
this
Returns
this
schema
schema
()
:
string
Returns
string
Protected
set
Remaining
setRemaining
(
remaining
:
number
)
:
void
Parameters
remaining
:
number
Returns
void
Protected
set
Start
setStart
(
start
:
number
)
:
void
Parameters
start
:
number
Returns
void
validate
validate
()
:
Promise
<
Error
[]
>
Returns
Promise
<
Error
[]
>
Static
as
as
<
T
extends
Payload
=
Payload
>
(
value
:
unknown
)
:
null
|
PayloadDataWrapper
<
T
>
Type Parameters
T
extends
Payload
=
Payload
Parameters
value
:
unknown
Returns
null
|
PayloadDataWrapper
<
T
>
Static
load
load
(
address
:
Lowercase
<
string
>
)
:
Promise
<
null
|
PayloadDataWrapper
<
Payload
>
>
Parameters
address
:
Lowercase
<
string
>
Returns
Promise
<
null
|
PayloadDataWrapper
<
Payload
>
>
Static
parse
parse
<
T
extends
Payload
>
(
payload
?:
unknown
)
:
undefined
|
PayloadDataWrapper
<
T
>
Type Parameters
T
extends
Payload
Parameters
Optional
payload
:
unknown
Returns
undefined
|
PayloadDataWrapper
<
T
>
Static
set
Loader
Factory
setLoaderFactory
(
factory
:
null
|
PayloadLoaderFactory
)
:
void
Parameters
factory
:
null
|
PayloadLoaderFactory
Returns
void
Static
try
Parse
tryParse
<
T
extends
Payload
>
(
obj
:
unknown
)
:
undefined
|
PayloadDataWrapper
<
T
>
Type Parameters
T
extends
Payload
Parameters
obj
:
unknown
Returns
undefined
|
PayloadDataWrapper
<
T
>
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
Static
wrap
wrap
<
T
extends
Payload
>
(
payload
?:
T
|
PayloadDataWrapper
<
T
>
,
)
:
PayloadDataWrapper
<
T
>
Type Parameters
T
extends
Payload
Parameters
Optional
payload
:
T
|
PayloadDataWrapper
<
T
>
Returns
PayloadDataWrapper
<
T
>
Static
wrapped
Map
wrappedMap
<
T
extends
Payload
>
(
payloads
:
(
T
|
PayloadDataWrapper
<
T
>
)
[]
,
)
:
Promise
<
Record
<
string
,
PayloadDataWrapper
<
T
>
>
>
Type Parameters
T
extends
Payload
Parameters
payloads
: (
T
|
PayloadDataWrapper
<
T
>
)
[]
Returns
Promise
<
Record
<
string
,
PayloadDataWrapper
<
T
>
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
payload
loader
Factory
Accessors
frequency
Millis
remaining
Methods
check
End
consume
Remaining
data
Hash
get
Errors
get
Valid
next
schema
set
Remaining
set
Start
validate
as
load
parse
set
Loader
Factory
try
Parse
unwrap
unwrap
Single
Payload
wrap
wrapped
Map
XYO Platform SDK - v3.9.16
Loading...