@uiowa/uiowa-mfk/lib/models/mfk-field-option.d.ts

mfk, uiowa-mfk, uiowa-favorite-mfk, mfk-string

import { Mfk } from './mfk';
/**
 * Options for MFK field.
 *
 * allows to set field default value, set readonly attribute, set validation regex pattern.  Example usage:
 *
 * ```typescript
 * new MfkFieldOption(MfkFieldName.IACT, '6218')
 * new MfkFieldOption(MfkFieldName.IACT, '6218', true)
 * new MfkFieldOption(MfkFieldName.BRF)
 * ```
 */
export declare class MfkFieldOption {
    readonly name: keyof Mfk;
    readonly defaultValue: string;
    readonly readonly: boolean;
    readonly valuePattern: string;
    readonly label: string;
    readonly width: number;
    readonly length: number;
    private readonly numericRegex;
    /**
     * Options for MFK field.
     *
     * allows to set field default value, set readonly attribute, set validation regex pattern.  Example usage:
     *
     * ```typescript
     * new MfkFieldOption(MfkFieldName.IACT, '6218')
     * new MfkFieldOption(MfkFieldName.IACT, '6218', true)
     * new MfkFieldOption(MfkFieldName.BRF)
     * ```
     *
     * @param name         (Required) the input field name. Use MfkFieldName type to get a proper value.
     * @param defaultValue (Optional) set a default value for this field. Default: ''.
     * @param readonly     (Optional) set to true if the input field is readonly. Default: false.
     * @param valuePattern (Optional) set a regex for this field. Default: '^[0-9]+$'.
     */
    constructor(name: keyof Mfk, defaultValue?: string, readonly?: boolean, valuePattern?: string);
}