UNPKG

810 BTypeScriptView Raw
1import type { Arbitrary } from '../check/arbitrary/definition/Arbitrary.js';
2import type { SizeForArbitrary } from './_internals/helpers/MaxLengthFromMinLength.js';
3/**
4 * Constraints to be applied on {@link webPath}
5 * @remarks Since 3.3.0
6 * @public
7 */
8export interface WebPathConstraints {
9 /**
10 * Define how large the generated values should be (at max)
11 * @remarks Since 3.3.0
12 */
13 size?: Exclude<SizeForArbitrary, 'max'>;
14}
15/**
16 * For web path
17 *
18 * According to {@link https://www.ietf.org/rfc/rfc3986.txt | RFC 3986} and
19 * {@link https://url.spec.whatwg.org/ | WHATWG URL Standard}
20 *
21 * @param constraints - Constraints to apply when building instances
22 *
23 * @remarks Since 3.3.0
24 * @public
25 */
26export declare function webPath(constraints?: WebPathConstraints): Arbitrary<string>;