Filtra

Validate and filter incoming data

Installation

npm i --save filtra

Example usage

const Filtra = require('filtra')
const moment = require('moment')

const request = {
  ownerid: 1,
  name: '  Gizmo ',
  weight: '.72',
  commentary: '  Don’t get him wet, \n\r  keep him out of bright light,   and\t never feed him after midnight   ',
  registered: '3/1/18',
  externalid: '416ac246-e7ac-49ff-93b4-f7e94d997e6b',
  price: '9.99',
  priceunit: 'usd',
  garbageProperty1: 'dq2dq2da2dre2e',
  garbageProperty2: {
    a: 'dasd'
  }
}

try {
  const data =
  Filtra(request)
  .int('ownerid').min(1).rename('owner_id')
  .str('name').trim().range(3, 100).toLowerCase().match(/^[a-z]+$/).rename('pet_name')
  .num('weight').min(0)
  .str('weightunit', 'kg').toLowerCase().any(['kg', 'g', 'oz', 'lb', 'cwt']).rename('weight_unit')
  .strOpt('commentary').trimDeep()
  .date('registered', '1/1/18').format('M/D/YY').range('1/1/18', moment()).toString('YYYY-MM-DD')
  .uuidV4('externalid').rename('external_id')
  .str('priceunit').toUpperCase().any(['USD', 'CENT']).rename('price_unit')
  .num('price').min(0).apply((price, props) => {
    if (props.price_unit === 'USD') {
      props.price_unit = 'CENT'
      return price * 100
    } else return price
  }).integer().rename('price_cents')
  .delete('price_unit')
  .flag('iscat', false).rename('is_cat')
  .filter()

  console.log(data)
  /* prints
  { owner_id: 1,
    pet_name: 'gizmo',
    weight: 0.72,
    weight_unit: 'kg',
    commentary: 'Don’t get him wet, keep him out of bright light, and never feed him after midnight',
    registered: '2018-03-01',
    external_id: '416ac246-e7ac-49ff-93b4-f7e94d997e6b',
    price_cents: 999,
    is_cat: false }
  */

} catch (error) {
  console.log('what\'s wrong:', error.message)
  throw error
}

try {
  Filtra(request)
  .int('ownerid').min(100)
} catch (error) {
  console.log('what\'s wrong:', error.message)
  console.log('param:', error.param)
  /* prints
    what's wrong: ownerid can't be less than 100
    param: ownerid
  */
  throw error
}

Usage

Filtra(sourceObject)

returns new FiltraChainLink, throws if !sourceObject

Chain methods

.filter()

retuns filtered object

.require(key)

thows if key doesn't exists in sourceObject

.delete(key)

delete already added property

Common property methods

.apply(handler)

executes handler(property, props) with current property value and already filtered properties. handler should return new value of property

.any(array) OR .in(array)

checks what property is in array

.check(handler, optionalMessage)

executes handler(property, [message]) with current property value. handler should return true or false. throws error if false

.rename(newKey)

rename property

Property types

.prop(key, default)

reads property by key, replaces undefined -> null

For next someOpt() null values are allowable:

.flag(key, default) .flagOpt(key, default)

reads boolean property: true, false, 'true', 'false', 't', 'f', 'yes', 'no'

.str(key, default) .strOpt(key, default)

reads string methods: min(minLenght), max(maxLenght), range(min, max), match(regExp), notEmpty(), toUpperCase(), toLowerCase(), trim(), trimDeep()

.num(key, default) .numOpt(key, default)

reads number methods: min(min), max(max), range(min, max), integer()

.int(key, default) .intOpt(key, default)

reads int methods: min(min), max(max), range(min, max)

.date(key, default).format(FORMAT) .dateOpt(key, default).format(FORMAT)

reads date as string methods: min(min), max(max), range(min, max), toString(format) (min & max are Moment instances or strings formatted with FORMAT)

.uuidV4(key, default) .uuidV4Opt(key, default)

reads UUIDv4 as string

grbr / filtra Goto Github PK

filtra's Introduction