TimerDurableClientOptions interface
Configures options for a timer-triggered Durable Client function.
- Extends
-
Omit<TimerFunctionOptions, "handler">
Properties
handler |
Inherited Properties
extra |
Configuration for an optional set of secondary inputs
During invocation, get these values with |
extra |
Configuration for an optional set of secondary outputs
During invocation, set these values with |
retry | An optional retry policy to rerun a failed execution until either successful completion occurs or the maximum number of retries is reached. Learn more here |
return | Configuration for the optional primary output of the function This is the main output that you should set as the return value of the function handler during invocation |
run |
If |
schedule | A cron expression of the format '{second} {minute} {hour} {day} {month} {day of week}' to specify the schedule |
trigger | |
use |
When true, schedule will be persisted to aid in maintaining the correct schedule even through restarts. Defaults to true for schedules with interval >= 1 minute |
Property Details
handler
Inherited Property Details
extraInputs
Configuration for an optional set of secondary inputs
During invocation, get these values with context.extraInputs.get()
extraInputs?: FunctionInput[]
Property Value
Inherited From Omit.extraInputs
extraOutputs
Configuration for an optional set of secondary outputs
During invocation, set these values with context.extraOutputs.set()
extraOutputs?: FunctionOutput[]
Property Value
Inherited From Omit.extraOutputs
retry
An optional retry policy to rerun a failed execution until either successful completion occurs or the maximum number of retries is reached. Learn more here
retry?: RetryOptions
Property Value
Inherited From Omit.retry
return
Configuration for the optional primary output of the function This is the main output that you should set as the return value of the function handler during invocation
return?: FunctionOutput
Property Value
Inherited From Omit.return
runOnStartup
If true
, the function is invoked when the runtime starts.
For example, the runtime starts when the function app wakes up after going idle due to inactivity, when the function app restarts due to function changes, and when the function app scales out.
Use with caution. runOnStartup should rarely if ever be set to true
, especially in production.
runOnStartup?: boolean
Property Value
boolean
Inherited From Omit.runOnStartup
schedule
A cron expression of the format '{second} {minute} {hour} {day} {month} {day of week}' to specify the schedule
schedule: string
Property Value
string
Inherited From Omit.schedule
trigger
useMonitor
When true, schedule will be persisted to aid in maintaining the correct schedule even through restarts. Defaults to true for schedules with interval >= 1 minute
useMonitor?: boolean
Property Value
boolean
Inherited From Omit.useMonitor