# @mapbox/frontend-util-validators > Validators. Latest version **0.5.0** (published 2018-03-14) · SEE LICENSE IN LICENSE_Mapbox license · 0 weekly downloads ## Install ```sh npm install @mapbox/frontend-util-validators pnpm add @mapbox/frontend-util-validators yarn add @mapbox/frontend-util-validators bun add @mapbox/frontend-util-validators ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.5.0 | | Published | 2018-03-14 | | First published | 2017-08-03 | | Weekly downloads | 0 | | License | SEE LICENSE IN LICENSE_Mapbox | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 17.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Mapbox | | Maintainers | 1ec5, aaaandrea, aag6z, aarthykc, ajashton, akit, alianthes, aliceykuo, alinapaz, allierowan, alulsh, amishas157, ampetr89, amyleew, anandthakker, andygol, angela.navarro, ansis, aparlato, apavani, apendleton, arunasank, asheemmamoowala, atevans-mapbox, benjamintd, bhousel, bkowshik, boblannon, brendanmcfarland, brsbl, brunoabinader, bsrinivasa, bsudekum, camillacaros, camilo.sanin, cammace, captainbarbosa-mbx, caseymm, castledoor, charloyd, chaupow, chetangowda, chriscx, chrisloer, cknouss, cmtoomey, colleenmcginnis, d-prukop, danieljh, danmactough, danpat, danpaz-mb, danswick, dasulit, davidtheclark, deniskoronchik, dgearhart, dhcole, dianeschulze, dnesbitt, dnomadb, dputtick, drboyer, dthompson, edgar-marca, electrostat, elifitch, emilymcafee, emilymdubois, enf, ericdeveloper, eschow, fa7c0n, fabianguerra, flippmoke, franka, freenerd, friedbunny, geografa, ghoshkaj, gknisely, gretacb, guardiola31337, heyadam_mapbox, hjudge, ian29, ianshward, ilyasaf, ingalls, isiyu, ivovandongen, jacquestardie, jayana, jc-clark, jcsg, jfirebaugh, jim-martin, jinnycho503, jjanczyszyn, jmkiley, jordanwebb, jothirnadh, jrpruit1, juliannebg, k-mahoney, kaibot3000, kalimar, karenell, karenzshea, katydecorah, kdiluca, kellyoung, kepta, kevinkreiser, kilatsat, kkaefer, l-r, langstonsmith, lbud, lily-chai, lingoded, lizziegooding, lobenichou, lshig, lucaswoj, luiswalter, lukasmartinelli, lukaspaczos, lxbarth, lyzidiamond, macro-shen, maikyon, mal-wood, maning, manoharuss, mapbox-admin, mapsam, markmisener, mateov, matt.gosline, mattficke, mcwhittemore, miccolis, mikelmaron, millzpaugh, mollymerp, morgane, morganherlocker, mourner, msirenko, mtirwin, nammala, natslaughter, nickcordella, nickidlugash, nickitaliano, nikhilprabhakar, nmargolis, norchard, normanb, oini, okoriep, oliikit, oormilavinod, otherwiseman, oxidase, paigemoody, pdgoodman, perrygeo, peterqliu, planemad, poornibadrinath, pratikyadav, pt-44, pveugen, rasagy, rclark, rcleedev, recursivefunk, rmrice, ryan-baumann, s-heisler, sabaelhilo, sabzo, sadiew, saikia.abhishek, samanbb, samely, samfader, sbma44, scottschultz, scottsfarley93, sgillies, springmeyer, srividyacb, tapasweni-pathak, taziam, tcql, themarex, tmpsantos, tony-cj, tridip1931, tristen, upendrayadav, vakila, vincents, virginiayung, vladimir.kananovich, willwhite, xianny, yhahn, yuffster, yuletide, zmully, zugaldia, zurihunter92 | ## Links - npm: https://www.npmjs.com/package/@mapbox/frontend-util-validators - Repository: https://github.com/mapbox/mapbox-react-components - Homepage: https://github.com/mapbox/mapbox-react-components/tree/master/packages/frontend-util-validators#readme - Issues: https://github.com/mapbox/mapbox-react-components/issues - npm.io page: https://npm.io/package/@mapbox/frontend-util-validators ## Recent versions - 0.5.0 (latest) — 2018-03-14 - 0.4.1 — 2017-11-09 - 0.4.0 — 2017-10-02 - 0.3.0 — 2017-09-25 - 0.2.0 — 2017-08-25 - 0.1.0 — 2017-08-03 ## README # @mapbox/frontend-util-validators Validators that work nicely with `@mapbox/react-form` and `@mapbox/react-control-*` components. Every validator is its own module inside `@mapbox/frontend-util-validators/dist/`, which you should import individually: ```js import validateRequired from '@mapbox/frontend-util-validators/dist/validate-required'; ``` ## Installation ``` npm install @mapbox/frontend-util-validators ``` ## Usage ``` // Examples import validateRequired from '@mapbox/frontend-util-validators/dist/validate-required'; import validateEmail from '@mapbox/frontend-util-validators/dist/validate-email'; ``` The validator function signature is `(value) => string`, and the return value is an empty string if there is no error. Some validator module are validator functions. But some are functions that *return* validator functions. This is necessary if the validator function varies from one case to another. For example, the `validateRequired` module takes an argument, a string describing the required value, and returns a validator function. ``` // How to use validateRequired import validateRequired from '@mapbox/frontend-util-validators/dist/validate-required'; const validateRequiredEmail = validateRequired('email'); // ... set value variable ... const validationError = validateRequiredEmail(value); ``` All validator function except the one returned by `validateRequired` return no error if the value is empty. They are intended to be used in tandem with `validateRequired` when the value is required. ## Validators ### validate-access-token ``` import validateAccessToken from '@mapbox/frontend-util-validators/dist/validate-access-token'; ``` Validates that the value is a valid Mapbox access token. Standard validator function signature. ### validate-bearing ``` import validateBearing from '@mapbox/frontend-util-validators/dist/validate-bearing'; ``` Validates that the value is a number between `-180` and `180`. Standard validator function signature. ### validate-date ``` import validateDate from '@mapbox/frontend-util-validators/dist/validate-date'; ``` Validates that the value is a `Date` object. Standard validator function signature. ### validate-email ``` import validateEmail from '@mapbox/frontend-util-validators/dist/validate-email'; ``` Validates that the value is an email address according to the following criteria: - Contains an `@`. Standard validator function signature. ### validate-latitude ``` import validateLatitude from '@mapbox/frontend-util-validators/dist/validate-latitude'; ``` Validates that the value is a number between `-90` and `90`. Standard validator function signature. ### validate-longitude ``` import validateLongitude from '@mapbox/frontend-util-validators/dist/validate-longitude'; ``` Validates that the value is a number between `-180` and `180`. Standard validator function signature. ### validate-number-between `validateNumberBetween(low: number, high: number): Validator` ``` import validateNumberBetween from '@mapbox/frontend-util-validators/dist/validate-number-between'; const validateNumberBetween10and30 = validateNumberBetween(10, 30); // ... set value variable ... const validationError = validateNumberBetween10and30(value); ``` Validates that the value is a number within a specified range, higher than (and not equal to) `low` and lower than (and not equal to) `high`. ### validate-number ``` import validateNumber from '@mapbox/frontend-util-validators/dist/validate-number'; ``` Validates that the value is a number, or a string that can be coerced to a number. Standard validator function signature. ### validate-password ``` import validatePassword from '@mapbox/frontend-util-validators/dist/validate-password'; ``` Validates that the value is a password according to the following criteria: - 8 or more characters. Standard validator function signature. ### validate-pitch ``` import validatePitch from '@mapbox/frontend-util-validators/dist/validate-pitch'; ``` Validates that the value is a number between `0` and `60`. Standard validator function signature. ### validate-required `validateRequired(partialMessage: ?string, fullMessage: ?string): Validator` You must provide either a partial or full error message to show the user. Typically, you can use a partial message. It will be plugged into the sentence ``Please enter a/an ${partialMessage}``. Provide a full message if you need special language or face one of the situations where a computer might pick the wrong indefinite article, e.g. "Please enter an username". ``` import validateRequired from '@mapbox/frontend-util-validators/dist/validate-required'; const validateRequiredEmail = validateRequired('email'); // ... set value variable ... const validationError = validateRequiredEmail(value); // validationError will be "" or "Please enter an email.". const validateRequiredUsername = validateRequired(null, 'Enter a username!'); // ... set value variable ... const validationError = validateRequiredEmail(value); // validationError will be "" or "Enter a username!". ``` Validates that the value is not empty. "Empty" values are `""`, `undefined`, and `null`. ### validate-start-date-before-end-date ``` import validateStartDateBeforeEndDate from '@mapbox/frontend-util-validators/dist/validate-start-date-before-end-date'; ``` Value must be an object with a `date` property (the "start date") and an `endDate` property. Validates that `endDate` is before `date`. Standard validator function signature. ### validate-style-uri ``` import validateStyleUri from '@mapbox/frontend-util-validators/dist/validate-style-uri'; ``` Validates that the value is a Mapbox style URI according to the following criteria: - Looks like `mapbox://styles/{something}/{something}`. Standard validator function signature. ### validate-zoom ``` import validatePitch from '@mapbox/frontend-util-validators/dist/validate-zoom'; ``` Validates that the value is a number between `0` and `22`. Standard validator function signature. --- _Source: https://npm.io/package/@mapbox/frontend-util-validators · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._