Module "api/goal/common/createGoal"

Index

Interfaces

Functions

Object literals

DefaultWaitRules

Functions

createPredicatedGoal

createPredicatedGoal(egi: EssentialGoalInfo, goalExecutor: ExecuteGoal, w: WaitRules): Goal

- Defined in lib/api/goal/common/createGoal.ts:58
Create a goal from the given executor, waiting until a condition is satisfied, with a given timeout.

Parameters
- egi: EssentialGoalInfo
- goalExecutor: ExecuteGoal
- w: WaitRules
  
  rules for waiting
Returns Goal

createPredicatedGoalExecutor

createPredicatedGoalExecutor(uniqueName: string, goalExecutor: ExecuteGoal, w: WaitRules, unref?: boolean): ExecuteGoal

- Defined in lib/api/goal/common/createGoal.ts:69
Wrap provided ExecuteGoal instance with WaitRules processing

Parameters
- uniqueName: string
- goalExecutor: ExecuteGoal
- w: WaitRules
  
  rules for waiting
- Default value unref: boolean = true
Returns ExecuteGoal

createRetryingGoalExecutor

createRetryingGoalExecutor(uniqueName: string, goalExecutor: ExecuteGoal, retry: RetryOptions): ExecuteGoal

- Defined in lib/api/goal/common/createGoal.ts:100
Parameters
- uniqueName: string
- goalExecutor: ExecuteGoal
- retry: RetryOptions
Returns ExecuteGoal

wait

wait(timeoutMillis: number, unref: boolean): Promise<void>

- Defined in lib/api/goal/common/createGoal.ts:119
Parameters
- timeoutMillis: number
- unref: boolean
Returns Promise<void>

Object literals

Const DefaultWaitRules

DefaultWaitRules: object

retries

retries: number = 1000

timeoutSeconds

timeoutSeconds: number = 1

Generated using TypeDoc