UNPKG

801 BTypeScriptView Raw
1/**
2 * A jar of form fields to store form data by handling
3 * array gracefully
4 */
5export declare class FormFields {
6 private config;
7 private fields;
8 constructor(config: {
9 convertEmptyStringsToNull: boolean;
10 });
11 /**
12 * Add a new key/value pair. The keys with array like
13 * expressions are handled properly.
14 *
15 * @example
16 * ```
17 * formfields.add('username', 'virk')
18 *
19 * // array
20 * formfields.add('username[]', 'virk')
21 * formfields.add('username[]', 'nikk')
22 *
23 * // Indexed keys are orderd properly
24 * formfields.add('username[1]', 'virk')
25 * formfields.add('username[0]', 'nikk')
26 * ```
27 */
28 add(key: string, value: any): void;
29 /**
30 * Returns the copy of form fields
31 */
32 get(): any;
33}