1 | import { Arbitrary } from '../check/arbitrary/definition/Arbitrary';
|
2 | import { AsyncCommand } from '../check/model/command/AsyncCommand';
|
3 | import { Command } from '../check/model/command/Command';
|
4 | import { CommandsContraints } from '../check/model/commands/CommandsContraints';
|
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 maxCommands - Maximal number of commands to build
|
13 | *
|
14 | * @deprecated
|
15 | * Superceded by `fc.commands(commandArbs, {maxCommands})` - see {@link https://github.com/dubzzz/fast-check/issues/992 | #992}.
|
16 | * Ease the migration with {@link https://github.com/dubzzz/fast-check/tree/main/codemods/unify-signatures | our codemod script}.
|
17 | *
|
18 | * @remarks Since 1.5.0
|
19 | * @public
|
20 | */
|
21 | declare function commands<Model extends object, Real, CheckAsync extends boolean>(commandArbs: Arbitrary<AsyncCommand<Model, Real, CheckAsync>>[], maxCommands?: number): Arbitrary<Iterable<AsyncCommand<Model, Real, CheckAsync>>>;
|
22 | /**
|
23 | * For arrays of {@link Command} to be executed by {@link modelRun}
|
24 | *
|
25 | * This implementation comes with a shrinker adapted for commands.
|
26 | * It should shrink more efficiently than {@link array} for {@link Command} arrays.
|
27 | *
|
28 | * @param commandArbs - Arbitraries responsible to build commands
|
29 | * @param maxCommands - Maximal number of commands to build
|
30 | *
|
31 | * @deprecated
|
32 | * Superceded by `fc.commands(commandArbs, {maxCommands})` - see {@link https://github.com/dubzzz/fast-check/issues/992 | #992}.
|
33 | * Ease the migration with {@link https://github.com/dubzzz/fast-check/tree/main/codemods/unify-signatures | our codemod script}.
|
34 | *
|
35 | * @remarks Since 1.5.0
|
36 | * @public
|
37 | */
|
38 | declare function commands<Model extends object, Real>(commandArbs: Arbitrary<Command<Model, Real>>[], maxCommands?: number): Arbitrary<Iterable<Command<Model, Real>>>;
|
39 | /**
|
40 | * For arrays of {@link AsyncCommand} to be executed by {@link asyncModelRun}
|
41 | *
|
42 | * This implementation comes with a shrinker adapted for commands.
|
43 | * It should shrink more efficiently than {@link array} for {@link AsyncCommand} arrays.
|
44 | *
|
45 | * @param commandArbs - Arbitraries responsible to build commands
|
46 | * @param constraints - Contraints to be applied when generating the commands
|
47 | *
|
48 | * @remarks Since 1.11.0
|
49 | * @public
|
50 | */
|
51 | declare function commands<Model extends object, Real, CheckAsync extends boolean>(commandArbs: Arbitrary<AsyncCommand<Model, Real, CheckAsync>>[], constraints?: CommandsContraints): Arbitrary<Iterable<AsyncCommand<Model, Real, CheckAsync>>>;
|
52 | /**
|
53 | * For arrays of {@link Command} to be executed by {@link modelRun}
|
54 | *
|
55 | * This implementation comes with a shrinker adapted for commands.
|
56 | * It should shrink more efficiently than {@link array} for {@link Command} arrays.
|
57 | *
|
58 | * @param commandArbs - Arbitraries responsible to build commands
|
59 | * @param constraints - Constraints to be applied when generating the commands
|
60 | *
|
61 | * @remarks Since 1.11.0
|
62 | * @public
|
63 | */
|
64 | declare function commands<Model extends object, Real>(commandArbs: Arbitrary<Command<Model, Real>>[], constraints?: CommandsContraints): Arbitrary<Iterable<Command<Model, Real>>>;
|
65 | export { commands };
|