UNPKG

1.06 kBTypeScriptView Raw
1import type { Arbitrary } from '../check/arbitrary/definition/Arbitrary.js';
2import type { DoubleConstraints } from './double.js';
3import type { SizeForArbitrary } from './_internals/helpers/MaxLengthFromMinLength.js';
4/**
5 * Constraints to be applied on {@link float64Array}
6 * @remarks Since 2.9.0
7 * @public
8 */
9export type Float64ArrayConstraints = {
10 /**
11 * Lower bound of the generated array size
12 * @defaultValue 0
13 * @remarks Since 2.9.0
14 */
15 minLength?: number;
16 /**
17 * Upper bound of the generated array size
18 * @defaultValue 0x7fffffff — _defaulting seen as "max non specified" when `defaultSizeToMaxWhenMaxSpecified=true`_
19 * @remarks Since 2.9.0
20 */
21 maxLength?: number;
22 /**
23 * Define how large the generated values should be (at max)
24 * @remarks Since 2.22.0
25 */
26 size?: SizeForArbitrary;
27} & DoubleConstraints;
28/**
29 * For Float64Array
30 * @remarks Since 2.9.0
31 * @public
32 */
33export declare function float64Array(constraints?: Float64ArrayConstraints): Arbitrary<Float64Array>;