Documentation
Preparing search index...
rivetkit
driver-helpers/mod
RunConfigSchema
Variable RunConfigSchema
Const
RunConfigSchema
:
ZodDefault
<
ZodObject
<
{
autoConfigureServerless
:
ZodOptional
<
ZodUnion
<
[
ZodBoolean
,
ZodObject
<
{
headers
:
ZodOptional
<
ZodRecord
<
(...)
,
(...)
>
>
;
maxRunners
:
ZodOptional
<
ZodNumber
>
;
metadata
:
ZodOptional
<
ZodRecord
<
(...)
,
(...)
>
>
;
minRunners
:
ZodOptional
<
ZodNumber
>
;
requestLifespan
:
ZodOptional
<
ZodNumber
>
;
runnersMargin
:
ZodOptional
<
ZodNumber
>
;
slotsPerRunner
:
ZodOptional
<
ZodNumber
>
;
url
:
ZodOptional
<
ZodString
>
;
}
,
"strip"
,
ZodTypeAny
,
{
headers
?:
Record
<
(...)
,
(...)
>
;
maxRunners
?:
number
;
metadata
?:
Record
<
(...)
,
(...)
>
;
minRunners
?:
number
;
requestLifespan
?:
number
;
runnersMargin
?:
number
;
slotsPerRunner
?:
number
;
url
?:
string
;
}
,
{
headers
?:
Record
<
(...)
,
(...)
>
;
maxRunners
?:
number
;
metadata
?:
Record
<
(...)
,
(...)
>
;
minRunners
?:
number
;
requestLifespan
?:
number
;
runnersMargin
?:
number
;
slotsPerRunner
?:
number
;
url
?:
string
;
}
,
>
,
]
,
>
,
>
;
basePath
:
ZodDefault
<
ZodOptional
<
ZodString
>
>
;
defaultServerPort
:
ZodDefault
<
ZodNumber
>
;
disableActorDriver
:
ZodDefault
<
ZodOptional
<
ZodBoolean
>
>
;
disableDefaultServer
:
ZodDefault
<
ZodOptional
<
ZodBoolean
>
>
;
driver
:
ZodOptional
<
ZodObject
<
{
actor
:
ZodType
<
ActorDriverBuilder
,
ZodTypeDef
,
ActorDriverBuilder
>
;
manager
:
ZodType
<
ManagerDriverBuilder
,
ZodTypeDef
,
ManagerDriverBuilder
,
>
;
name
:
ZodString
;
}
,
"strip"
,
ZodTypeAny
,
{
actor
:
ActorDriverBuilder
;
manager
:
ManagerDriverBuilder
;
name
:
string
;
}
,
{
actor
:
ActorDriverBuilder
;
manager
:
ManagerDriverBuilder
;
name
:
string
;
}
,
>
,
>
;
inspector
:
ZodDefault
<
ZodOptional
<
ZodObject
<
{
defaultEndpoint
:
ZodOptional
<
ZodString
>
;
enabled
:
ZodDefault
<
ZodOptional
<
ZodUnion
<
(...)
>
>
>
;
token
:
ZodDefault
<
ZodOptional
<
ZodFunction
<
(...)
,
(...)
>
>
>
;
}
,
"strip"
,
ZodTypeAny
,
{
defaultEndpoint
?:
string
;
enabled
:
boolean
|
{
actor
:
boolean
;
manager
:
boolean
}
;
token
:
(
...
args
:
unknown
[]
)
=>
string
;
}
,
{
defaultEndpoint
?:
string
;
enabled
?:
|
boolean
|
{
actor
?:
(...)
|
(...)
|
(...)
;
manager
?:
(...)
|
(...)
|
(...)
}
;
token
?:
(
...
args
:
(...)
[]
)
=>
string
;
}
,
>
,
>
,
>
;
logging
:
ZodDefault
<
ZodOptional
<
ZodObject
<
{
baseLogger
:
ZodOptional
<
ZodType
<
Logger
,
ZodTypeDef
,
Logger
>
>
;
level
:
ZodOptional
<
ZodEnum
<
[
(...)
,
(...)
,
(...)
,
(...)
,
(...)
,
(...)
,
(...)
]
>
,
>
;
}
,
"strip"
,
ZodTypeAny
,
{
baseLogger
?:
Logger
;
level
?:
|
"error"
|
"trace"
|
"fatal"
|
"warn"
|
"info"
|
"debug"
|
"silent"
;
}
,
{
baseLogger
?:
Logger
;
level
?:
|
"error"
|
"trace"
|
"fatal"
|
"warn"
|
"info"
|
"debug"
|
"silent"
;
}
,
>
,
>
,
>
;
maxIncomingMessageSize
:
ZodDefault
<
ZodOptional
<
ZodNumber
>
>
;
noWelcome
:
ZodDefault
<
ZodOptional
<
ZodBoolean
>
>
;
overrideServerAddress
:
ZodOptional
<
ZodString
>
;
runEngine
:
ZodDefault
<
ZodOptional
<
ZodBoolean
>
>
;
runEngineVersion
:
ZodDefault
<
ZodOptional
<
ZodString
>
>
;
runnerKind
:
ZodDefault
<
ZodOptional
<
ZodEnum
<
[
"serverless"
,
"normal"
]
>
>
>
;
}
&
{
disableMetadataLookup
:
ZodDefault
<
ZodOptional
<
ZodBoolean
>
>
;
encoding
:
ZodDefault
<
ZodEnum
<
[
"json"
,
"cbor"
,
"bare"
]
>
>
;
endpoint
:
ZodEffects
<
ZodOptional
<
ZodString
>
,
string
|
undefined
,
string
|
undefined
,
>
;
getUpgradeWebSocket
:
ZodOptional
<
ZodType
<
GetUpgradeWebSocket
,
ZodTypeDef
,
GetUpgradeWebSocket
>
,
>
;
headers
:
ZodDefault
<
ZodOptional
<
ZodRecord
<
ZodString
,
ZodString
>
>
>
;
namespace
:
ZodDefault
<
ZodString
>
;
runnerKey
:
ZodEffects
<
ZodOptional
<
ZodString
>
,
string
|
undefined
,
string
|
undefined
,
>
;
runnerName
:
ZodDefault
<
ZodString
>
;
token
:
ZodEffects
<
ZodOptional
<
ZodString
>
,
string
|
undefined
,
string
|
undefined
,
>
;
totalSlots
:
ZodDefault
<
ZodNumber
>
;
}
,
"strip"
,
ZodTypeAny
,
{
autoConfigureServerless
?:
|
boolean
|
{
headers
?:
Record
<
string
,
string
>
;
maxRunners
?:
number
;
metadata
?:
Record
<
string
,
unknown
>
;
minRunners
?:
number
;
requestLifespan
?:
number
;
runnersMargin
?:
number
;
slotsPerRunner
?:
number
;
url
?:
string
;
}
;
basePath
:
string
;
defaultServerPort
:
number
;
disableActorDriver
:
boolean
;
disableDefaultServer
:
boolean
;
disableMetadataLookup
:
boolean
;
driver
?:
{
actor
:
ActorDriverBuilder
;
manager
:
ManagerDriverBuilder
;
name
:
string
;
}
;
encoding
:
"json"
|
"cbor"
|
"bare"
;
endpoint
?:
string
;
getUpgradeWebSocket
?:
GetUpgradeWebSocket
;
headers
:
Record
<
string
,
string
>
;
inspector
:
{
defaultEndpoint
?:
string
;
enabled
:
boolean
|
{
actor
:
boolean
;
manager
:
boolean
}
;
token
:
(
...
args
:
unknown
[]
)
=>
string
;
}
;
logging
:
{
baseLogger
?:
Logger
;
level
?:
|
"error"
|
"trace"
|
"fatal"
|
"warn"
|
"info"
|
"debug"
|
"silent"
;
}
;
maxIncomingMessageSize
:
number
;
namespace
:
string
;
noWelcome
:
boolean
;
overrideServerAddress
?:
string
;
runEngine
:
boolean
;
runEngineVersion
:
string
;
runnerKey
?:
string
;
runnerKind
:
"serverless"
|
"normal"
;
runnerName
:
string
;
token
?:
string
;
totalSlots
:
number
;
}
,
{
autoConfigureServerless
?:
|
boolean
|
{
headers
?:
Record
<
string
,
string
>
;
maxRunners
?:
number
;
metadata
?:
Record
<
string
,
unknown
>
;
minRunners
?:
number
;
requestLifespan
?:
number
;
runnersMargin
?:
number
;
slotsPerRunner
?:
number
;
url
?:
string
;
}
;
basePath
?:
string
;
defaultServerPort
?:
number
;
disableActorDriver
?:
boolean
;
disableDefaultServer
?:
boolean
;
disableMetadataLookup
?:
boolean
;
driver
?:
{
actor
:
ActorDriverBuilder
;
manager
:
ManagerDriverBuilder
;
name
:
string
;
}
;
encoding
?:
"json"
|
"cbor"
|
"bare"
;
endpoint
?:
string
;
getUpgradeWebSocket
?:
GetUpgradeWebSocket
;
headers
?:
Record
<
string
,
string
>
;
inspector
?:
{
defaultEndpoint
?:
string
;
enabled
?:
boolean
|
{
actor
?:
boolean
;
manager
?:
boolean
}
;
token
?:
(
...
args
:
unknown
[]
)
=>
string
;
}
;
logging
?:
{
baseLogger
?:
Logger
;
level
?:
|
"error"
|
"trace"
|
"fatal"
|
"warn"
|
"info"
|
"debug"
|
"silent"
;
}
;
maxIncomingMessageSize
?:
number
;
namespace
?:
string
;
noWelcome
?:
boolean
;
overrideServerAddress
?:
string
;
runEngine
?:
boolean
;
runEngineVersion
?:
string
;
runnerKey
?:
string
;
runnerKind
?:
"serverless"
|
"normal"
;
runnerName
?:
string
;
token
?:
string
;
totalSlots
?:
number
;
}
,
>
,
>
= ...
Base config used for the actor config across all platforms.
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
Documentation
Loading...
Base config used for the actor config across all platforms.