ChaosOutcomeOptions
Defined in: src/chaos.ts:23
Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”T
Properties
Section titled “Properties”enabled?
Section titled “enabled?”
optionalenabled?:boolean
Defined in: src/chaos.ts:9
Default true. Ignored when enabledGenerator is set.
Inherited from
Section titled “Inherited from”enabledGenerator?
Section titled “enabledGenerator?”
optionalenabledGenerator?: (args) =>MaybePromise<boolean>
Defined in: src/chaos.ts:10
Parameters
Section titled “Parameters”ContextArgs
Returns
Section titled “Returns”MaybePromise<boolean>
Inherited from
Section titled “Inherited from”injectionRate?
Section titled “injectionRate?”
optionalinjectionRate?:number
Defined in: src/chaos.ts:12
Probability in [0, 1]. Default 0.001. Ignored when injectionRateGenerator is set.
Inherited from
Section titled “Inherited from”injectionRateGenerator?
Section titled “injectionRateGenerator?”
optionalinjectionRateGenerator?: (args) =>MaybePromise<number>
Defined in: src/chaos.ts:13
Parameters
Section titled “Parameters”ContextArgs
Returns
Section titled “Returns”MaybePromise<number>
Inherited from
Section titled “Inherited from”ChaosOptions.injectionRateGenerator
optionalname?:string
Defined in: src/chaos.ts:7
Inherited from
Section titled “Inherited from”onOutcomeInjected?
Section titled “onOutcomeInjected?”
optionalonOutcomeInjected?: (args) =>MaybePromise<void>
Defined in: src/chaos.ts:26
Parameters
Section titled “Parameters”ContextArgs & object
Returns
Section titled “Returns”MaybePromise<void>
outcome?
Section titled “outcome?”
optionaloutcome?:Outcome<T>
Defined in: src/chaos.ts:24
outcomeGenerator?
Section titled “outcomeGenerator?”
optionaloutcomeGenerator?: (args) =>MaybePromise<Outcome<T> |undefined>
Defined in: src/chaos.ts:25
Parameters
Section titled “Parameters”ContextArgs
Returns
Section titled “Returns”MaybePromise<Outcome<T> | undefined>
randomizer?
Section titled “randomizer?”
optionalrandomizer?: () =>number
Defined in: src/chaos.ts:14
Returns
Section titled “Returns”number