ramda-fantasy-validation's Introduction

ramda-fantasy-validation

Fantasy Land compatible Validation with Ramda.

Example

var Validation = require('ramda-fantasy-validation');
var R = require('ramda');

function validateName(name) {
  if (name.length > 0) {
    return Validation.of(name);
  }
  return Validation.failure(['Name is required.']);
}

function validateAge(age) {
  if (age >= 18) {
    return Validation.of(age);
  }
  return Validation.failure(['Age must be or over 18.']);
}

function createUser(name, age) {
  return { 'name': name, 'age': age };
}

// Validation.Success({"age": 99, "name": "mrkm4ntr"})
validateName('mrkm4ntr').map(R.curry(createUser)).ap(validateAge(99));
// or
Validation.liftAN(2, createUser)(validateName('mrkm4ntr'))(validateAge(99));

// Validation can accumulate error informations.
// Validation.Failure(["Name is required.", "Age must be or over 18."])
Validation.liftAN(2, createUser)(validateName(''))(validateAge(17));

ramda-fantasy-validation's People

Contributors

Stargazers

Watchers

ramda-fantasy-validation's Issues

Easier syntax idea

Thanks for the great validation library. I was trying to find a cleaner way to use this and came up with this. If this is correct in all cases it might be good for the docs.

const R = require('ramda');
const Validation = require('ramda-fantasy-validation');

R.useWith(
 Validation.liftAN(3, functionToValidate),
 [
    validate('type', [String]),
    validate('ret', [Object, String]),
    validate('obj', [Object])
 ]
);

// where functionToValidate has those arguments
const functionToValidate = (type, ret, obj) => ...

// validate is whatever validation function you want, so long as it expects the parameter value to be supplied as the final argument. Example:
 const validate = module.exports.validate = R.curry((name, types, value) =>
   R.ifElse(
     v => R.any(type => R.is(type, v), types),
     Validation.of,
     _ => Validation.failure([`Requires ${name} as one of ${R.join(', ', R.map(t => R.type(t()), types))}, but got ${value}`]) // e.g. Validation.Failure('Requires ret as one of Object, String, but got 1')
   )(value)
);

fold function is incorrect

Should be
fold(f1, f2) { return this.isSuccess ? f1(this.value) : f2(this.value); }
but instead is
fold(f1, f2) { return this.success ? f1(this.value) : f2(this.value); }

Recommend Projects