UNPKG

1.97 kBTypeScriptView Raw
1import { Arbitrary } from '../check/arbitrary/definition/Arbitrary';
2import { StringSharedConstraints } from './_internals/helpers/StringConstraintsExtractor';
3export { StringSharedConstraints } from './_internals/helpers/StringConstraintsExtractor';
4/**
5 * For base64 strings
6 *
7 * A base64 string will always have a length multiple of 4 (padded with =)
8 *
9 * @remarks Since 0.0.1
10 * @public
11 */
12declare function base64String(): Arbitrary<string>;
13/**
14 * For base64 strings
15 *
16 * A base64 string will always have a length multiple of 4 (padded with =)
17 *
18 * @param maxLength - Upper bound of the generated string length
19 *
20 * @deprecated
21 * Superceded by `fc.base64String({maxLength})` - see {@link https://github.com/dubzzz/fast-check/issues/992 | #992}.
22 * Ease the migration with {@link https://github.com/dubzzz/fast-check/tree/main/codemods/unify-signatures | our codemod script}.
23 *
24 * @remarks Since 0.0.1
25 * @public
26 */
27declare function base64String(maxLength: number): Arbitrary<string>;
28/**
29 * For base64 strings
30 *
31 * A base64 string will always have a length multiple of 4 (padded with =)
32 *
33 * @param minLength - Lower bound of the generated string length
34 * @param maxLength - Upper bound of the generated string length
35 *
36 * @deprecated
37 * Superceded by `fc.base64String({minLength, maxLength})` - see {@link https://github.com/dubzzz/fast-check/issues/992 | #992}.
38 * Ease the migration with {@link https://github.com/dubzzz/fast-check/tree/main/codemods/unify-signatures | our codemod script}.
39 *
40 * @remarks Since 0.0.11
41 * @public
42 */
43declare function base64String(minLength: number, maxLength: number): Arbitrary<string>;
44/**
45 * For base64 strings
46 *
47 * A base64 string will always have a length multiple of 4 (padded with =)
48 *
49 * @param constraints - Constraints to apply when building instances
50 *
51 * @remarks Since 2.4.0
52 * @public
53 */
54declare function base64String(constraints: StringSharedConstraints): Arbitrary<string>;
55export { base64String };