Function: schedulerFor()

Call Signature

schedulerFor<TMetaData>(constraints?): (_strs, ...ordering) => Scheduler<TMetaData>

Defined in: packages/fast-check/src/arbitrary/scheduler.ts:66

For custom scheduler with predefined resolution order

Ordering is defined by using a template string like the one generated in case of failure of a scheduler

It may be something like:

Type Parameters

Type Parameter	Default type
TMetaData	unknown

Parameters

Parameter	Type
constraints?	SchedulerConstraints

Returns

(_strs, ...ordering) => Scheduler<TMetaData>

Example

fc.schedulerFor()`
  -> [task\${2}] promise pending
  -> [task\${3}] promise pending
  -> [task\${1}] promise pending
`

Or more generally:

fc.schedulerFor()`
  This scheduler will resolve task ${2} first
  followed by ${3} and only then task ${1}
`

WARNING: Custom scheduler will neither check that all the referred promises have been scheduled nor that they resolved with the same status and value.

WARNING: If one the promises is wrongly defined it will fail - for instance asking to resolve 5 while 5 does not exist.

Remarks

Since 1.25.0

Call Signature

schedulerFor<TMetaData>(customOrdering, constraints?): Scheduler<TMetaData>

Defined in: packages/fast-check/src/arbitrary/scheduler.ts:85

For custom scheduler with predefined resolution order

WARNING: Custom scheduler will not check that all the referred promises have been scheduled.

WARNING: If one the promises is wrongly defined it will fail - for instance asking to resolve 5 while 5 does not exist.

Type Parameters

Type Parameter	Default type
TMetaData	unknown

Parameters

Parameter	Type	Description
customOrdering	number[]	Array defining in which order the promises will be resolved. Id of the promises start at 1. 1 means first scheduled promise, 2 second scheduled promise and so on.
constraints?	SchedulerConstraints	-

Returns

Scheduler<TMetaData>

Remarks

Since 1.25.0