1 | import type { Arbitrary } from '../check/arbitrary/definition/Arbitrary.js';
|
2 | import type { ObjectConstraints } from './_internals/helpers/QualifiedObjectConstraints.js';
|
3 | export type { ObjectConstraints };
|
4 | /**
|
5 | * For any objects
|
6 | *
|
7 | * You may use {@link sample} to preview the values that will be generated
|
8 | *
|
9 | * @example
|
10 | * ```javascript
|
11 | * {}, {k: [{}, 1, 2]}
|
12 | * ```
|
13 | *
|
14 | * @remarks Since 0.0.7
|
15 | * @public
|
16 | */
|
17 | declare function object(): Arbitrary<Record<string, unknown>>;
|
18 | /**
|
19 | * For any objects following the constraints defined by `settings`
|
20 | *
|
21 | * You may use {@link sample} to preview the values that will be generated
|
22 | *
|
23 | * @example
|
24 | * ```javascript
|
25 | * {}, {k: [{}, 1, 2]}
|
26 | * ```
|
27 | *
|
28 | * @param constraints - Constraints to apply when building instances
|
29 | *
|
30 | * @remarks Since 0.0.7
|
31 | * @public
|
32 | */
|
33 | declare function object(constraints: ObjectConstraints): Arbitrary<Record<string, unknown>>;
|
34 | export { object };
|