UNPKG

1.63 kBTypeScriptView Raw
1import type { Arbitrary } from '../check/arbitrary/definition/Arbitrary.js';
2import type { AsyncCommand } from '../check/model/command/AsyncCommand.js';
3import type { Command } from '../check/model/command/Command.js';
4import type { CommandsContraints } from '../check/model/commands/CommandsContraints.js';
5/**
6 * For arrays of {@link AsyncCommand} to be executed by {@link asyncModelRun}
7 *
8 * This implementation comes with a shrinker adapted for commands.
9 * It should shrink more efficiently than {@link array} for {@link AsyncCommand} arrays.
10 *
11 * @param commandArbs - Arbitraries responsible to build commands
12 * @param constraints - Constraints to be applied when generating the commands (since 1.11.0)
13 *
14 * @remarks Since 1.5.0
15 * @public
16 */
17declare function commands<Model extends object, Real, CheckAsync extends boolean>(commandArbs: Arbitrary<AsyncCommand<Model, Real, CheckAsync>>[], constraints?: CommandsContraints): Arbitrary<Iterable<AsyncCommand<Model, Real, CheckAsync>>>;
18/**
19 * For arrays of {@link Command} to be executed by {@link modelRun}
20 *
21 * This implementation comes with a shrinker adapted for commands.
22 * It should shrink more efficiently than {@link array} for {@link Command} arrays.
23 *
24 * @param commandArbs - Arbitraries responsible to build commands
25 * @param constraints - Constraints to be applied when generating the commands (since 1.11.0)
26 *
27 * @remarks Since 1.5.0
28 * @public
29 */
30declare function commands<Model extends object, Real>(commandArbs: Arbitrary<Command<Model, Real>>[], constraints?: CommandsContraints): Arbitrary<Iterable<Command<Model, Real>>>;
31export { commands };