Preparing search index...
The search index is not available
XYO Platform SDK - v3.9.16
XYO Platform SDK
@xyo-network/module-model
ModuleFields
Interface ModuleFields<TParams>
interface
ModuleFields
<
TParams
extends
ModuleParams
=
ModuleParams
>
{
address
:
Lowercase
<
string
>
;
config
:
TParams
[
"config"
]
;
id
:
string
;
modName
?:
string
;
params
:
TParams
;
previousHash
:
()
=>
Promisable
<
undefined
|
string
>
;
queries
:
string
[]
;
query
:
<
T
extends
UnsignedQueryBoundWitness
=
UnsignedQueryBoundWitness
,
TConf
extends
ModuleConfig
=
ModuleConfig
,
>
(
query
:
T
,
payloads
?:
Payload
[]
,
queryConfig
?:
TConf
,
)
=>
Promisable
<
ModuleQueryResult
>
;
queryable
:
<
T
extends
UnsignedQueryBoundWitness
=
UnsignedQueryBoundWitness
,
TConf
extends
ModuleConfig
=
ModuleConfig
,
>
(
query
:
T
,
payloads
?:
Payload
[]
,
queryConfig
?:
TConf
,
)
=>
Promisable
<
boolean
>
;
start
?:
()
=>
Promisable
<
boolean
>
;
stop
?:
()
=>
Promisable
<
boolean
>
;
}
Type Parameters
TParams
extends
ModuleParams
=
ModuleParams
Hierarchy (
View Summary
)
ModuleFields
Module
Index
Properties
address
config
id
mod
Name?
params
previous
Hash
queries
query
queryable
start?
stop?
Properties
address
address
:
Lowercase
<
string
>
config
config
:
TParams
[
"config"
]
id
id
:
string
The name (if specified) or address of the module
Optional
mod
Name
modName
?:
string
params
params
:
TParams
previous
Hash
previousHash
:
()
=>
Promisable
<
undefined
|
string
>
queries
queries
:
string
[]
query
query
:
<
T
extends
UnsignedQueryBoundWitness
=
UnsignedQueryBoundWitness
,
TConf
extends
ModuleConfig
=
ModuleConfig
,
>
(
query
:
T
,
payloads
?:
Payload
[]
,
queryConfig
?:
TConf
,
)
=>
Promisable
<
ModuleQueryResult
>
queryable
queryable
:
<
T
extends
UnsignedQueryBoundWitness
=
UnsignedQueryBoundWitness
,
TConf
extends
ModuleConfig
=
ModuleConfig
,
>
(
query
:
T
,
payloads
?:
Payload
[]
,
queryConfig
?:
TConf
,
)
=>
Promisable
<
boolean
>
Optional
start
start
?:
()
=>
Promisable
<
boolean
>
Optional
stop
stop
?:
()
=>
Promisable
<
boolean
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
address
config
id
mod
Name
params
previous
Hash
queries
query
queryable
start
stop
XYO Platform SDK - v3.9.16
Loading...
The name (if specified) or address of the module