Preparing search index...
The search index is not available
XYO Platform SDK - v3.6.9
XYO Platform SDK
@xyo-network/bridge
BridgeParams
Interface BridgeParams<TConfig>
interface
BridgeParams
<
TConfig
extends
AnyConfigSchema
<
BridgeConfig
>
=
AnyConfigSchema
<
BridgeConfig
>
,
>
{
account
?:
AccountInstance
|
"random"
;
additionalSigners
?:
AccountInstance
[]
;
addToResolvers
?:
boolean
;
allowNameResolution
?:
boolean
;
config
:
TConfig
extends
DeepRestrictToStringKeys
<
{
allowedQueries
?:
string
[]
;
archiving
?:
{
archivists
?:
string
[]
;
queries
?:
string
[]
}
;
archivist
?:
string
;
consoleLogger
?:
LogLevel
;
labels
?:
{
[
key
:
string
]:
undefined
|
string
}
;
name
?:
string
;
paging
?:
{
[
key
:
string
]:
{
size
?:
number
}
}
;
retry
?:
{
backoff
?:
number
;
interval
?:
number
;
retries
?:
number
}
;
schema
:
string
;
security
?:
{
allowAnonymous
?:
boolean
;
allowed
?:
{
[
key
:
string
]:
(
Lowercase
<
string
>
|
Lowercase
<
(...)
>
[]
)
[]
}
;
disallowed
?:
{
[
key
:
string
]:
Lowercase
<
string
>
[]
}
;
}
;
sign
?:
boolean
;
storeQueries
?:
boolean
;
timestamp
?:
boolean
;
}
,
>
?
TConfig
<
TConfig
>
:
DeepRestrictToStringKeys
<
{
allowedQueries
?:
string
[]
;
archiving
?:
{
archivists
?:
string
[]
;
queries
?:
string
[]
}
;
archivist
?:
string
;
consoleLogger
?:
LogLevel
;
labels
?:
{
[
key
:
string
]:
undefined
|
string
}
;
name
?:
string
;
paging
?:
{
[
key
:
string
]:
{
size
?:
number
}
}
;
retry
?:
{
backoff
?:
number
;
interval
?:
number
;
retries
?:
number
}
;
schema
:
string
;
security
?:
{
allowAnonymous
?:
boolean
;
allowed
?:
{
[
key
:
string
]:
(
Lowercase
<
string
>
|
Lowercase
<
(...)
>
[]
)
[]
}
;
disallowed
?:
{
[
key
:
string
]:
Lowercase
<
string
>
[]
}
;
}
;
sign
?:
boolean
;
storeQueries
?:
boolean
;
timestamp
?:
boolean
;
}
,
>
;
ephemeralQueryAccountEnabled
?:
boolean
;
logger
?:
Logger
;
moduleIdentifierTransformers
?:
ModuleIdentifierTransformer
[]
;
resolver
?:
ModuleResolverInstance
;
}
Type Parameters
TConfig
extends
AnyConfigSchema
<
BridgeConfig
>
=
AnyConfigSchema
<
BridgeConfig
>
Hierarchy (
View Summary
)
ModuleParams
<
TConfig
>
BridgeParams
HttpBridgeParams
Index
Properties
account?
additional
Signers?
add
To
Resolvers?
allow
Name
Resolution?
config
ephemeral
Query
Account
Enabled?
logger?
module
Identifier
Transformers?
resolver?
Properties
Optional
account
account
?:
AccountInstance
|
"random"
Optional
additional
Signers
additionalSigners
?:
AccountInstance
[]
Optional
add
To
Resolvers
addToResolvers
?:
boolean
Optional
allow
Name
Resolution
allowNameResolution
?:
boolean
config
config
:
TConfig
extends
DeepRestrictToStringKeys
<
{
allowedQueries
?:
string
[]
;
archiving
?:
{
archivists
?:
string
[]
;
queries
?:
string
[]
}
;
archivist
?:
string
;
consoleLogger
?:
LogLevel
;
labels
?:
{
[
key
:
string
]:
undefined
|
string
}
;
name
?:
string
;
paging
?:
{
[
key
:
string
]:
{
size
?:
number
}
}
;
retry
?:
{
backoff
?:
number
;
interval
?:
number
;
retries
?:
number
}
;
schema
:
string
;
security
?:
{
allowAnonymous
?:
boolean
;
allowed
?:
{
[
key
:
string
]:
(
Lowercase
<
string
>
|
Lowercase
<
(...)
>
[]
)
[]
}
;
disallowed
?:
{
[
key
:
string
]:
Lowercase
<
string
>
[]
}
;
}
;
sign
?:
boolean
;
storeQueries
?:
boolean
;
timestamp
?:
boolean
;
}
,
>
?
TConfig
<
TConfig
>
:
DeepRestrictToStringKeys
<
{
allowedQueries
?:
string
[]
;
archiving
?:
{
archivists
?:
string
[]
;
queries
?:
string
[]
}
;
archivist
?:
string
;
consoleLogger
?:
LogLevel
;
labels
?:
{
[
key
:
string
]:
undefined
|
string
}
;
name
?:
string
;
paging
?:
{
[
key
:
string
]:
{
size
?:
number
}
}
;
retry
?:
{
backoff
?:
number
;
interval
?:
number
;
retries
?:
number
}
;
schema
:
string
;
security
?:
{
allowAnonymous
?:
boolean
;
allowed
?:
{
[
key
:
string
]:
(
Lowercase
<
string
>
|
Lowercase
<
(...)
>
[]
)
[]
}
;
disallowed
?:
{
[
key
:
string
]:
Lowercase
<
string
>
[]
}
;
}
;
sign
?:
boolean
;
storeQueries
?:
boolean
;
timestamp
?:
boolean
;
}
,
>
Optional
ephemeral
Query
Account
Enabled
ephemeralQueryAccountEnabled
?:
boolean
Optional
logger
logger
?:
Logger
Optional
module
Identifier
Transformers
moduleIdentifierTransformers
?:
ModuleIdentifierTransformer
[]
Optional
resolver
resolver
?:
ModuleResolverInstance
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
account
additional
Signers
add
To
Resolvers
allow
Name
Resolution
config
ephemeral
Query
Account
Enabled
logger
module
Identifier
Transformers
resolver
XYO Platform SDK - v3.6.9
Loading...