@alextheman/utility 2.21.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.cjs +492 -622
  2. package/dist/index.d.cts +133 -91
  3. package/dist/index.d.ts +133 -91
  4. package/dist/index.js +431 -558
  5. package/package.json +4 -3
package/dist/index.d.cts CHANGED
@@ -1,149 +1,191 @@
1
- import z, { z as z$1, core, ZodType } from 'zod';
2
-
3
- declare function addDaysToDate(currentDate?: Date, dayIncrement?: number): Date;
1
+ import z, { ZodType, core, z as z$1 } from "zod";
4
2
 
3
+ //#region src/functions/appendSemicolon.d.ts
5
4
  declare function appendSemicolon(stringToAppendTo: string): string;
6
-
5
+ //#endregion
6
+ //#region src/functions/arrayHelpers/fillArray.d.ts
7
+ declare function fillArray<T>(callback: (index: number) => Promise<T>, length?: number): Promise<T[]>;
8
+ declare function fillArray<T>(callback: (index: number) => T, length?: number): T[];
9
+ //#endregion
10
+ //#region src/functions/arrayHelpers/paralleliseArrays.d.ts
11
+ type ParallelTuple<A, B> = [A, B | undefined];
12
+ declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray: FirstArrayItem[] | readonly FirstArrayItem[], secondArray: SecondArrayItem[] | readonly SecondArrayItem[]): ParallelTuple<FirstArrayItem, SecondArrayItem>[];
13
+ //#endregion
14
+ //#region src/functions/arrayHelpers/randomiseArray.d.ts
15
+ declare function randomiseArray<T>(array: T[]): T[];
16
+ //#endregion
17
+ //#region src/functions/arrayHelpers/range.d.ts
18
+ declare function range(start: number, stop: number, step?: number): number[];
19
+ //#endregion
20
+ //#region src/functions/camelToKebab.d.ts
7
21
  declare function camelToKebab(string: string): string;
8
-
22
+ //#endregion
23
+ //#region src/functions/convertFileToBase64.d.ts
9
24
  declare function convertFileToBase64(file: File): Promise<string>;
10
-
25
+ //#endregion
26
+ //#region src/types/APIError.d.ts
11
27
  type HTTPErrorCode = 400 | 401 | 403 | 404 | 418 | 500;
12
- /** @deprecated This type has been renamed to HTTPErrorCode (singular) */
13
- type HTTPErrorCodes = 400 | 401 | 403 | 404 | 418 | 500;
14
28
  declare const httpErrorCodeLookup: Record<HTTPErrorCode, string>;
15
29
  declare class APIError extends Error {
16
- status: number;
17
- constructor(status?: HTTPErrorCode | number, message?: string, options?: ErrorOptions);
18
- static check(input: unknown): input is APIError;
30
+ status: number;
31
+ constructor(status?: HTTPErrorCode | number, message?: string, options?: ErrorOptions);
32
+ static check(input: unknown): input is APIError;
19
33
  }
20
-
34
+ //#endregion
35
+ //#region src/types/DataError.d.ts
21
36
  declare class DataError extends Error {
22
- data: unknown;
23
- code: string;
24
- /** @param data - The data that caused the error. */
25
- /** @param message - A human-readable error message (e.g. The data provided is invalid). */
26
- /** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
27
- /** @param options - Extra options to pass to super Error constructor. */
28
- constructor(data: unknown, message?: string, code?: string, options?: ErrorOptions);
29
- static check(input: unknown): input is DataError;
37
+ data: unknown;
38
+ code: string;
39
+ /** @param data - The data that caused the error. */
40
+ /** @param message - A human-readable error message (e.g. The data provided is invalid). */
41
+ /** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
42
+ /** @param options - Extra options to pass to super Error constructor. */
43
+ constructor(data: unknown, message?: string, code?: string, options?: ErrorOptions);
44
+ static check(input: unknown): input is DataError;
30
45
  }
31
-
46
+ //#endregion
47
+ //#region src/types/Email.d.ts
32
48
  declare const emailSchema: z.core.$ZodBranded<z.ZodEmail, "Email">;
33
49
  type Email = z.infer<typeof emailSchema>;
34
50
  declare function parseEmail(data: unknown): Email;
35
-
51
+ //#endregion
52
+ //#region src/types/Env.d.ts
36
53
  declare const envSchema: z$1.ZodEnum<{
37
- test: "test";
38
- development: "development";
39
- production: "production";
54
+ test: "test";
55
+ development: "development";
56
+ production: "production";
40
57
  }>;
41
58
  type Env = z$1.infer<typeof envSchema>;
42
59
  declare function parseEnv(data?: unknown): Env;
43
-
60
+ //#endregion
61
+ //#region src/types/UUID.d.ts
44
62
  declare const uuidSchema: z.core.$ZodBranded<z.ZodUUID, "UUID">;
45
63
  type UUID = z.infer<typeof uuidSchema>;
46
64
  declare function parseUUID(UUID: unknown): UUID;
47
-
65
+ //#endregion
66
+ //#region src/types/DisallowUndefined.d.ts
48
67
  type DisallowUndefined<T> = undefined extends T ? ["Error: Generic type cannot include undefined"] : T;
49
-
68
+ //#endregion
69
+ //#region src/types/IgnoreCase.d.ts
50
70
  type IgnoreCase<T extends string> = string extends T ? string : T extends `${infer F1}${infer F2}${infer R}` ? `${Uppercase<F1> | Lowercase<F1>}${Uppercase<F2> | Lowercase<F2>}${IgnoreCase<R>}` : T extends `${infer F}${infer R}` ? `${Uppercase<F> | Lowercase<F>}${IgnoreCase<R>}` : "";
51
-
71
+ //#endregion
72
+ //#region src/types/NonUndefined.d.ts
52
73
  type NonUndefined<T> = T extends undefined ? never : T;
53
-
74
+ //#endregion
75
+ //#region src/types/OptionalOnCondition.d.ts
54
76
  type OptionalOnCondition<Condition extends boolean, T> = Condition extends true ? T : T | undefined;
55
-
77
+ //#endregion
78
+ //#region src/types/RecordKey.d.ts
56
79
  type RecordKey = string | number | symbol;
57
-
80
+ //#endregion
81
+ //#region src/functions/createFormData.d.ts
58
82
  type FormDataNullableResolutionStrategy = "stringify" | "empty" | "omit";
59
83
  type FormDataArrayResolutionStrategy = "stringify" | "multiple";
60
84
  interface CreateFormDataOptionsBase<K extends RecordKey> {
61
- arrayResolution?: FormDataArrayResolutionStrategy | Partial<Record<K, FormDataArrayResolutionStrategy>>;
85
+ arrayResolution?: FormDataArrayResolutionStrategy | Partial<Record<K, FormDataArrayResolutionStrategy>>;
62
86
  }
63
87
  interface CreateFormDataOptionsUndefinedOrNullResolution<K extends RecordKey> extends CreateFormDataOptionsBase<K> {
64
- undefinedResolution?: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
65
- nullResolution?: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
66
- nullableResolution?: never;
88
+ undefinedResolution?: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
89
+ nullResolution?: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
90
+ nullableResolution?: never;
67
91
  }
68
92
  interface CreateFormDataOptionsNullableResolution<K extends RecordKey> extends CreateFormDataOptionsBase<K> {
69
- undefinedResolution?: never;
70
- nullResolution?: never;
71
- nullableResolution: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
93
+ undefinedResolution?: never;
94
+ nullResolution?: never;
95
+ nullableResolution: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
72
96
  }
73
97
  type CreateFormDataOptions<K extends RecordKey> = CreateFormDataOptionsUndefinedOrNullResolution<K> | CreateFormDataOptionsNullableResolution<K>;
74
98
  declare function createFormData<T extends Record<RecordKey, unknown>>(data: T, options?: CreateFormDataOptions<keyof T>): FormData;
75
-
99
+ //#endregion
100
+ //#region src/functions/createTemplateStringsArray.d.ts
76
101
  declare function createTemplateStringsArray(strings: readonly string[]): TemplateStringsArray;
77
-
78
- declare function fillArray<T>(callback: (index: number) => Promise<T>, length?: number): Promise<T[]>;
79
- declare function fillArray<T>(callback: (index: number) => T, length?: number): T[];
80
-
102
+ //#endregion
103
+ //#region src/functions/date/addDaysToDate.d.ts
104
+ declare function addDaysToDate(currentDate?: Date, dayIncrement?: number): Date;
105
+ //#endregion
106
+ //#region src/functions/date/formatDateAndTime.d.ts
81
107
  declare function formatDateAndTime(inputDate: Date): string;
82
-
83
- declare function getRandomNumber(lowerBound: number, upperBound: number): number;
84
-
85
- declare function getRecordKeys<T extends Record<RecordKey, unknown>>(record: T & object): (keyof T)[];
86
-
108
+ //#endregion
109
+ //#region src/functions/date/isAnniversary.d.ts
110
+ declare function isAnniversary(firstDate: Date, secondDate: Date): boolean;
111
+ //#endregion
112
+ //#region src/functions/date/isLeapYear.d.ts
87
113
  declare function isLeapYear(year: number): boolean;
88
-
114
+ //#endregion
115
+ //#region src/functions/date/isMonthlyMultiple.d.ts
89
116
  declare function isMonthlyMultiple(firstDate: Date, secondDate: Date): boolean;
90
-
91
- declare function isOrdered(array: readonly number[] | number[]): boolean;
92
-
117
+ //#endregion
118
+ //#region src/functions/date/isSameDate.d.ts
93
119
  declare function isSameDate(firstDate: Date, secondDate: Date): boolean;
94
-
120
+ //#endregion
121
+ //#region src/functions/getRandomNumber.d.ts
122
+ declare function getRandomNumber(lowerBound: number, upperBound: number): number;
123
+ //#endregion
124
+ //#region src/functions/getRecordKeys.d.ts
125
+ declare function getRecordKeys<T extends Record<RecordKey, unknown>>(record: T & object): (keyof T)[];
126
+ //#endregion
127
+ //#region src/functions/isOrdered.d.ts
128
+ declare function isOrdered(array: readonly number[] | number[]): boolean;
129
+ //#endregion
130
+ //#region src/functions/kebabToCamel.d.ts
95
131
  interface KebabToCamelOptions {
96
- startWithUpper?: boolean;
132
+ startWithUpper?: boolean;
97
133
  }
98
134
  declare function kebabToCamel(string: string, options?: KebabToCamelOptions): string;
99
-
135
+ //#endregion
136
+ //#region src/functions/normalizeImportPath.d.ts
100
137
  declare function normalizeImportPath(importPath: string): string;
101
138
  declare const normaliseImportPath: typeof normalizeImportPath;
102
-
139
+ //#endregion
140
+ //#region src/functions/omitProperties.d.ts
103
141
  declare function omitProperties<T extends Record<string, unknown> | Readonly<Record<string, unknown>>, K extends keyof T>(object: T, keysToOmit: K | readonly K[]): Omit<T, K>;
104
-
105
- type ParallelTuple<A, B> = [A, B | undefined];
106
- declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray: FirstArrayItem[] | readonly FirstArrayItem[], secondArray: SecondArrayItem[] | readonly SecondArrayItem[]): ParallelTuple<FirstArrayItem, SecondArrayItem>[];
107
-
142
+ //#endregion
143
+ //#region src/functions/parsers/parseBoolean.d.ts
144
+ declare function parseBoolean(inputString: string): boolean;
145
+ /** @deprecated This function has been renamed to parseBoolean. */
146
+ declare const stringToBoolean: typeof parseBoolean;
147
+ //#endregion
148
+ //#region src/functions/parsers/parseFormData.d.ts
149
+ declare function parseFormData<T>(formData: FormData, dataParser: (data: Record<string, string | Blob>) => T): T;
150
+ declare function parseFormData(formData: FormData): Record<string, string | Blob>;
151
+ //#endregion
152
+ //#region src/functions/parsers/parseIntStrict.d.ts
108
153
  declare function parseIntStrict(...[string, radix]: Parameters<typeof parseInt>): number;
109
-
154
+ //#endregion
155
+ //#region src/functions/parsers/parseZodSchema.d.ts
110
156
  declare function parseZodSchema<Output, Input, Internals extends core.$ZodTypeInternals<Output, Input>>(schema: ZodType<Output, Input, Internals>, data: unknown): core.output<ZodType<Output, Input, Internals>>;
111
-
112
- declare function randomiseArray<T>(array: T[]): T[];
113
-
114
- declare function range(start: number, stop: number, step?: number): number[];
115
-
157
+ //#endregion
158
+ //#region src/functions/removeDuplicates.d.ts
116
159
  declare function removeDuplicates<T>(array: T[] | readonly T[]): T[];
117
-
160
+ //#endregion
161
+ //#region src/functions/stringListToArray.d.ts
118
162
  interface StringListToArrayOptions {
119
- separator?: string;
120
- trimWhitespace?: boolean;
163
+ separator?: string;
164
+ trimWhitespace?: boolean;
121
165
  }
122
- declare function stringListToArray(stringList: string, { separator, trimWhitespace }?: StringListToArrayOptions): string[];
123
-
124
- declare function stringToBoolean(inputString: string): boolean;
125
-
126
- declare function truncate(stringToTruncate: string, maxLength?: number): string;
127
-
128
- declare function wait(seconds: number): Promise<void>;
129
-
166
+ declare function stringListToArray(stringList: string, {
167
+ separator,
168
+ trimWhitespace
169
+ }?: StringListToArrayOptions): string[];
170
+ //#endregion
171
+ //#region src/functions/taggedTemplate/interpolate.d.ts
130
172
  declare function interpolate(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
131
-
173
+ //#endregion
174
+ //#region src/functions/taggedTemplate/interpolateObjects.d.ts
132
175
  declare function interpolateObjects(strings: TemplateStringsArray, ...values: unknown[]): string;
133
-
176
+ //#endregion
177
+ //#region src/functions/taggedTemplate/removeIndents.d.ts
134
178
  interface RemoveIndentsOptions {
135
- preserveTabs?: boolean;
179
+ preserveTabs?: boolean;
136
180
  }
137
181
  type RemoveIndentsFunction = (strings: TemplateStringsArray, ...interpolations: unknown[]) => string;
138
182
  declare function removeIndents(options: RemoveIndentsOptions): RemoveIndentsFunction;
139
183
  declare function removeIndents(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
140
-
141
- interface StripIndentsOptions {
142
- whitespaceLength?: number;
143
- preserveTabs?: boolean;
144
- }
145
- type StripIndentsFunction = (strings: TemplateStringsArray, ...interpolations: unknown[]) => string;
146
- declare function stripIndents(options: StripIndentsOptions): StripIndentsFunction;
147
- declare function stripIndents(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
148
-
149
- export { APIError, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, type Email, type Env, type FormDataNullableResolutionStrategy as FormDataResolutionStrategy, type HTTPErrorCode, type HTTPErrorCodes, type IgnoreCase, type KebabToCamelOptions, type NonUndefined, type OptionalOnCondition, type RecordKey, type RemoveIndentsFunction, type RemoveIndentsOptions, type StringListToArrayOptions, type StripIndentsFunction, type StripIndentsOptions, type UUID, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, httpErrorCodeLookup, interpolate, interpolateObjects, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normalizeImportPath, omitProperties, paralleliseArrays, parseEmail, parseEnv, parseIntStrict, parseUUID, parseZodSchema, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, stripIndents, truncate, wait };
184
+ //#endregion
185
+ //#region src/functions/truncate.d.ts
186
+ declare function truncate(stringToTruncate: string, maxLength?: number): string;
187
+ //#endregion
188
+ //#region src/functions/wait.d.ts
189
+ declare function wait(seconds: number): Promise<void>;
190
+ //#endregion
191
+ export { APIError, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Email, Env, FormDataNullableResolutionStrategy as FormDataResolutionStrategy, HTTPErrorCode, IgnoreCase, KebabToCamelOptions, NonUndefined, OptionalOnCondition, RecordKey, RemoveIndentsFunction, RemoveIndentsOptions, StringListToArrayOptions, UUID, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normalizeImportPath, omitProperties, paralleliseArrays, parseBoolean, parseEmail, parseEnv, parseFormData, parseIntStrict, parseUUID, parseZodSchema, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, truncate, wait };
package/dist/index.d.ts CHANGED
@@ -1,149 +1,191 @@
1
- import z, { z as z$1, core, ZodType } from 'zod';
2
-
3
- declare function addDaysToDate(currentDate?: Date, dayIncrement?: number): Date;
1
+ import z, { ZodType, core, z as z$1 } from "zod";
4
2
 
3
+ //#region src/functions/appendSemicolon.d.ts
5
4
  declare function appendSemicolon(stringToAppendTo: string): string;
6
-
5
+ //#endregion
6
+ //#region src/functions/arrayHelpers/fillArray.d.ts
7
+ declare function fillArray<T>(callback: (index: number) => Promise<T>, length?: number): Promise<T[]>;
8
+ declare function fillArray<T>(callback: (index: number) => T, length?: number): T[];
9
+ //#endregion
10
+ //#region src/functions/arrayHelpers/paralleliseArrays.d.ts
11
+ type ParallelTuple<A, B> = [A, B | undefined];
12
+ declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray: FirstArrayItem[] | readonly FirstArrayItem[], secondArray: SecondArrayItem[] | readonly SecondArrayItem[]): ParallelTuple<FirstArrayItem, SecondArrayItem>[];
13
+ //#endregion
14
+ //#region src/functions/arrayHelpers/randomiseArray.d.ts
15
+ declare function randomiseArray<T>(array: T[]): T[];
16
+ //#endregion
17
+ //#region src/functions/arrayHelpers/range.d.ts
18
+ declare function range(start: number, stop: number, step?: number): number[];
19
+ //#endregion
20
+ //#region src/functions/camelToKebab.d.ts
7
21
  declare function camelToKebab(string: string): string;
8
-
22
+ //#endregion
23
+ //#region src/functions/convertFileToBase64.d.ts
9
24
  declare function convertFileToBase64(file: File): Promise<string>;
10
-
25
+ //#endregion
26
+ //#region src/types/APIError.d.ts
11
27
  type HTTPErrorCode = 400 | 401 | 403 | 404 | 418 | 500;
12
- /** @deprecated This type has been renamed to HTTPErrorCode (singular) */
13
- type HTTPErrorCodes = 400 | 401 | 403 | 404 | 418 | 500;
14
28
  declare const httpErrorCodeLookup: Record<HTTPErrorCode, string>;
15
29
  declare class APIError extends Error {
16
- status: number;
17
- constructor(status?: HTTPErrorCode | number, message?: string, options?: ErrorOptions);
18
- static check(input: unknown): input is APIError;
30
+ status: number;
31
+ constructor(status?: HTTPErrorCode | number, message?: string, options?: ErrorOptions);
32
+ static check(input: unknown): input is APIError;
19
33
  }
20
-
34
+ //#endregion
35
+ //#region src/types/DataError.d.ts
21
36
  declare class DataError extends Error {
22
- data: unknown;
23
- code: string;
24
- /** @param data - The data that caused the error. */
25
- /** @param message - A human-readable error message (e.g. The data provided is invalid). */
26
- /** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
27
- /** @param options - Extra options to pass to super Error constructor. */
28
- constructor(data: unknown, message?: string, code?: string, options?: ErrorOptions);
29
- static check(input: unknown): input is DataError;
37
+ data: unknown;
38
+ code: string;
39
+ /** @param data - The data that caused the error. */
40
+ /** @param message - A human-readable error message (e.g. The data provided is invalid). */
41
+ /** @param code - A standardised code (e.g. UNEXPECTED_DATA). */
42
+ /** @param options - Extra options to pass to super Error constructor. */
43
+ constructor(data: unknown, message?: string, code?: string, options?: ErrorOptions);
44
+ static check(input: unknown): input is DataError;
30
45
  }
31
-
46
+ //#endregion
47
+ //#region src/types/Email.d.ts
32
48
  declare const emailSchema: z.core.$ZodBranded<z.ZodEmail, "Email">;
33
49
  type Email = z.infer<typeof emailSchema>;
34
50
  declare function parseEmail(data: unknown): Email;
35
-
51
+ //#endregion
52
+ //#region src/types/Env.d.ts
36
53
  declare const envSchema: z$1.ZodEnum<{
37
- test: "test";
38
- development: "development";
39
- production: "production";
54
+ test: "test";
55
+ development: "development";
56
+ production: "production";
40
57
  }>;
41
58
  type Env = z$1.infer<typeof envSchema>;
42
59
  declare function parseEnv(data?: unknown): Env;
43
-
60
+ //#endregion
61
+ //#region src/types/UUID.d.ts
44
62
  declare const uuidSchema: z.core.$ZodBranded<z.ZodUUID, "UUID">;
45
63
  type UUID = z.infer<typeof uuidSchema>;
46
64
  declare function parseUUID(UUID: unknown): UUID;
47
-
65
+ //#endregion
66
+ //#region src/types/DisallowUndefined.d.ts
48
67
  type DisallowUndefined<T> = undefined extends T ? ["Error: Generic type cannot include undefined"] : T;
49
-
68
+ //#endregion
69
+ //#region src/types/IgnoreCase.d.ts
50
70
  type IgnoreCase<T extends string> = string extends T ? string : T extends `${infer F1}${infer F2}${infer R}` ? `${Uppercase<F1> | Lowercase<F1>}${Uppercase<F2> | Lowercase<F2>}${IgnoreCase<R>}` : T extends `${infer F}${infer R}` ? `${Uppercase<F> | Lowercase<F>}${IgnoreCase<R>}` : "";
51
-
71
+ //#endregion
72
+ //#region src/types/NonUndefined.d.ts
52
73
  type NonUndefined<T> = T extends undefined ? never : T;
53
-
74
+ //#endregion
75
+ //#region src/types/OptionalOnCondition.d.ts
54
76
  type OptionalOnCondition<Condition extends boolean, T> = Condition extends true ? T : T | undefined;
55
-
77
+ //#endregion
78
+ //#region src/types/RecordKey.d.ts
56
79
  type RecordKey = string | number | symbol;
57
-
80
+ //#endregion
81
+ //#region src/functions/createFormData.d.ts
58
82
  type FormDataNullableResolutionStrategy = "stringify" | "empty" | "omit";
59
83
  type FormDataArrayResolutionStrategy = "stringify" | "multiple";
60
84
  interface CreateFormDataOptionsBase<K extends RecordKey> {
61
- arrayResolution?: FormDataArrayResolutionStrategy | Partial<Record<K, FormDataArrayResolutionStrategy>>;
85
+ arrayResolution?: FormDataArrayResolutionStrategy | Partial<Record<K, FormDataArrayResolutionStrategy>>;
62
86
  }
63
87
  interface CreateFormDataOptionsUndefinedOrNullResolution<K extends RecordKey> extends CreateFormDataOptionsBase<K> {
64
- undefinedResolution?: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
65
- nullResolution?: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
66
- nullableResolution?: never;
88
+ undefinedResolution?: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
89
+ nullResolution?: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
90
+ nullableResolution?: never;
67
91
  }
68
92
  interface CreateFormDataOptionsNullableResolution<K extends RecordKey> extends CreateFormDataOptionsBase<K> {
69
- undefinedResolution?: never;
70
- nullResolution?: never;
71
- nullableResolution: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
93
+ undefinedResolution?: never;
94
+ nullResolution?: never;
95
+ nullableResolution: FormDataNullableResolutionStrategy | Partial<Record<K, FormDataNullableResolutionStrategy>>;
72
96
  }
73
97
  type CreateFormDataOptions<K extends RecordKey> = CreateFormDataOptionsUndefinedOrNullResolution<K> | CreateFormDataOptionsNullableResolution<K>;
74
98
  declare function createFormData<T extends Record<RecordKey, unknown>>(data: T, options?: CreateFormDataOptions<keyof T>): FormData;
75
-
99
+ //#endregion
100
+ //#region src/functions/createTemplateStringsArray.d.ts
76
101
  declare function createTemplateStringsArray(strings: readonly string[]): TemplateStringsArray;
77
-
78
- declare function fillArray<T>(callback: (index: number) => Promise<T>, length?: number): Promise<T[]>;
79
- declare function fillArray<T>(callback: (index: number) => T, length?: number): T[];
80
-
102
+ //#endregion
103
+ //#region src/functions/date/addDaysToDate.d.ts
104
+ declare function addDaysToDate(currentDate?: Date, dayIncrement?: number): Date;
105
+ //#endregion
106
+ //#region src/functions/date/formatDateAndTime.d.ts
81
107
  declare function formatDateAndTime(inputDate: Date): string;
82
-
83
- declare function getRandomNumber(lowerBound: number, upperBound: number): number;
84
-
85
- declare function getRecordKeys<T extends Record<RecordKey, unknown>>(record: T & object): (keyof T)[];
86
-
108
+ //#endregion
109
+ //#region src/functions/date/isAnniversary.d.ts
110
+ declare function isAnniversary(firstDate: Date, secondDate: Date): boolean;
111
+ //#endregion
112
+ //#region src/functions/date/isLeapYear.d.ts
87
113
  declare function isLeapYear(year: number): boolean;
88
-
114
+ //#endregion
115
+ //#region src/functions/date/isMonthlyMultiple.d.ts
89
116
  declare function isMonthlyMultiple(firstDate: Date, secondDate: Date): boolean;
90
-
91
- declare function isOrdered(array: readonly number[] | number[]): boolean;
92
-
117
+ //#endregion
118
+ //#region src/functions/date/isSameDate.d.ts
93
119
  declare function isSameDate(firstDate: Date, secondDate: Date): boolean;
94
-
120
+ //#endregion
121
+ //#region src/functions/getRandomNumber.d.ts
122
+ declare function getRandomNumber(lowerBound: number, upperBound: number): number;
123
+ //#endregion
124
+ //#region src/functions/getRecordKeys.d.ts
125
+ declare function getRecordKeys<T extends Record<RecordKey, unknown>>(record: T & object): (keyof T)[];
126
+ //#endregion
127
+ //#region src/functions/isOrdered.d.ts
128
+ declare function isOrdered(array: readonly number[] | number[]): boolean;
129
+ //#endregion
130
+ //#region src/functions/kebabToCamel.d.ts
95
131
  interface KebabToCamelOptions {
96
- startWithUpper?: boolean;
132
+ startWithUpper?: boolean;
97
133
  }
98
134
  declare function kebabToCamel(string: string, options?: KebabToCamelOptions): string;
99
-
135
+ //#endregion
136
+ //#region src/functions/normalizeImportPath.d.ts
100
137
  declare function normalizeImportPath(importPath: string): string;
101
138
  declare const normaliseImportPath: typeof normalizeImportPath;
102
-
139
+ //#endregion
140
+ //#region src/functions/omitProperties.d.ts
103
141
  declare function omitProperties<T extends Record<string, unknown> | Readonly<Record<string, unknown>>, K extends keyof T>(object: T, keysToOmit: K | readonly K[]): Omit<T, K>;
104
-
105
- type ParallelTuple<A, B> = [A, B | undefined];
106
- declare function paralleliseArrays<FirstArrayItem, SecondArrayItem>(firstArray: FirstArrayItem[] | readonly FirstArrayItem[], secondArray: SecondArrayItem[] | readonly SecondArrayItem[]): ParallelTuple<FirstArrayItem, SecondArrayItem>[];
107
-
142
+ //#endregion
143
+ //#region src/functions/parsers/parseBoolean.d.ts
144
+ declare function parseBoolean(inputString: string): boolean;
145
+ /** @deprecated This function has been renamed to parseBoolean. */
146
+ declare const stringToBoolean: typeof parseBoolean;
147
+ //#endregion
148
+ //#region src/functions/parsers/parseFormData.d.ts
149
+ declare function parseFormData<T>(formData: FormData, dataParser: (data: Record<string, string | Blob>) => T): T;
150
+ declare function parseFormData(formData: FormData): Record<string, string | Blob>;
151
+ //#endregion
152
+ //#region src/functions/parsers/parseIntStrict.d.ts
108
153
  declare function parseIntStrict(...[string, radix]: Parameters<typeof parseInt>): number;
109
-
154
+ //#endregion
155
+ //#region src/functions/parsers/parseZodSchema.d.ts
110
156
  declare function parseZodSchema<Output, Input, Internals extends core.$ZodTypeInternals<Output, Input>>(schema: ZodType<Output, Input, Internals>, data: unknown): core.output<ZodType<Output, Input, Internals>>;
111
-
112
- declare function randomiseArray<T>(array: T[]): T[];
113
-
114
- declare function range(start: number, stop: number, step?: number): number[];
115
-
157
+ //#endregion
158
+ //#region src/functions/removeDuplicates.d.ts
116
159
  declare function removeDuplicates<T>(array: T[] | readonly T[]): T[];
117
-
160
+ //#endregion
161
+ //#region src/functions/stringListToArray.d.ts
118
162
  interface StringListToArrayOptions {
119
- separator?: string;
120
- trimWhitespace?: boolean;
163
+ separator?: string;
164
+ trimWhitespace?: boolean;
121
165
  }
122
- declare function stringListToArray(stringList: string, { separator, trimWhitespace }?: StringListToArrayOptions): string[];
123
-
124
- declare function stringToBoolean(inputString: string): boolean;
125
-
126
- declare function truncate(stringToTruncate: string, maxLength?: number): string;
127
-
128
- declare function wait(seconds: number): Promise<void>;
129
-
166
+ declare function stringListToArray(stringList: string, {
167
+ separator,
168
+ trimWhitespace
169
+ }?: StringListToArrayOptions): string[];
170
+ //#endregion
171
+ //#region src/functions/taggedTemplate/interpolate.d.ts
130
172
  declare function interpolate(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
131
-
173
+ //#endregion
174
+ //#region src/functions/taggedTemplate/interpolateObjects.d.ts
132
175
  declare function interpolateObjects(strings: TemplateStringsArray, ...values: unknown[]): string;
133
-
176
+ //#endregion
177
+ //#region src/functions/taggedTemplate/removeIndents.d.ts
134
178
  interface RemoveIndentsOptions {
135
- preserveTabs?: boolean;
179
+ preserveTabs?: boolean;
136
180
  }
137
181
  type RemoveIndentsFunction = (strings: TemplateStringsArray, ...interpolations: unknown[]) => string;
138
182
  declare function removeIndents(options: RemoveIndentsOptions): RemoveIndentsFunction;
139
183
  declare function removeIndents(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
140
-
141
- interface StripIndentsOptions {
142
- whitespaceLength?: number;
143
- preserveTabs?: boolean;
144
- }
145
- type StripIndentsFunction = (strings: TemplateStringsArray, ...interpolations: unknown[]) => string;
146
- declare function stripIndents(options: StripIndentsOptions): StripIndentsFunction;
147
- declare function stripIndents(strings: TemplateStringsArray, ...interpolations: unknown[]): string;
148
-
149
- export { APIError, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, type Email, type Env, type FormDataNullableResolutionStrategy as FormDataResolutionStrategy, type HTTPErrorCode, type HTTPErrorCodes, type IgnoreCase, type KebabToCamelOptions, type NonUndefined, type OptionalOnCondition, type RecordKey, type RemoveIndentsFunction, type RemoveIndentsOptions, type StringListToArrayOptions, type StripIndentsFunction, type StripIndentsOptions, type UUID, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, httpErrorCodeLookup, interpolate, interpolateObjects, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normalizeImportPath, omitProperties, paralleliseArrays, parseEmail, parseEnv, parseIntStrict, parseUUID, parseZodSchema, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, stripIndents, truncate, wait };
184
+ //#endregion
185
+ //#region src/functions/truncate.d.ts
186
+ declare function truncate(stringToTruncate: string, maxLength?: number): string;
187
+ //#endregion
188
+ //#region src/functions/wait.d.ts
189
+ declare function wait(seconds: number): Promise<void>;
190
+ //#endregion
191
+ export { APIError, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, type Email, type Env, type FormDataNullableResolutionStrategy as FormDataResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type KebabToCamelOptions, type NonUndefined, type OptionalOnCondition, type RecordKey, RemoveIndentsFunction, RemoveIndentsOptions, type StringListToArrayOptions, type UUID, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normalizeImportPath, omitProperties, paralleliseArrays, parseBoolean, parseEmail, parseEnv, parseFormData, parseIntStrict, parseUUID, parseZodSchema, randomiseArray, range, removeDuplicates, removeIndents, stringListToArray, stringToBoolean, truncate, wait };