README.md

Validators

Validators are created as objects with the following fields. Only name is required.

• name The clear-language version of the field, usually same as the label shown in frontend. For example 'bfa_min_abs' field would have a name of 'Basis for age (absolute)'
• required Set to true if always requires some (non-empty) value. Can also be given a function that returns a ValidationError, if requirement and error strings are more conditional. Example usage can be found in locality validators.
• minLength
• maxLength Inclusive min and max length for value, applies only to string fields
• asString Either "true" to just require a string, or a function which can do more complex validation for the string value
• asNumber Same as asString but for numbers: Set to true to require a valid number, or set the function to both require a valid number (checked automatically if function is supplied) and apply more custom validations in the function body
• miscCheck is used to simply run any check you want. Currently it's used to e.g. validate the low_bound and up_bound fields of a time unit in the timeUnit validator.

Example:

    bfa_min_abs: {
      name: 'Basis for age (minimum)',
      asNumber: (num: number) => {
        const bfa_max_abs = editData.bfa_max_abs
        if (!bfa_max_abs) return
        if (parseInt(bfa_max_abs) > num) return 'Min value cannot be higher than max'
      },
    },

To know if user is creating a new entry or editing existing one, check if the id exists. For example put const isNew = editData.lid === undefined at the beginning of the entire validator so it can be used in all of the fields' validators.

Note!

The files in this folder, and also backendTypes.d.ts, cannot

• Use path aliases in imports
• Import files from elsewhere in frontend

Because these files are used also by backend, and backend container only gets access to these files in frontend.