/
CommandsContraints.ts
37 lines (36 loc) · 974 Bytes
/
CommandsContraints.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
import { SizeForArbitrary } from '../../../arbitrary/_internals/helpers/MaxLengthFromMinLength';
/**
* Parameters for {@link commands}
* @remarks Since 2.2.0
* @public
*/
export interface CommandsContraints {
/**
* Maximal number of commands to generate per run
*
* You probably want to use `size` instead.
*
* @defaultValue 0x7fffffff — _defaulting seen as "max non specified" when `defaultSizeToMaxWhenMaxSpecified=true`_
* @remarks Since 1.11.0
*/
maxCommands?: number;
/**
* Define how large the generated values (number of commands) should be (at max)
* @remarks Since 2.22.0
*/
size?: SizeForArbitrary;
/**
* Do not show replayPath in the output
* @defaultValue false
* @remarks Since 1.11.0
*/
disableReplayLog?: boolean;
/**
* Hint for replay purposes only
*
* Should be used in conjonction with `{ seed, path }` of {@link assert}
*
* @remarks Since 1.11.0
*/
replayPath?: string;
}