elasticsearch sense plugin

 Object schema description language and validator for JavaScript objects. [](http://badge.fury.io/js/joi) [](http://travis-ci.org/hapijs/joi) [](https://david-dm.org/hapijs/joi) [](https://david-dm.org/hapijs/joi#info=devDependencies) Lead Maintainer: [Nicolas Morel](https://github.com/marsup) ## Table of Contents <img src="https://raw.github.com/hapijs/joi/master/images/validation.png" align="right" /> <!-- toc --> - [Example](#example) - [Usage](#usage) - [`validate(value, schema, [options], [callback])`](#validatevalue-schema-options-callback) - [`compile(schema)`](#compileschema) - [`assert(value, schema, [message])`](#assertvalue-schema-message) - [`any`](#any) - [`any.allow(value)`](#anyallowvalue) - [`any.valid(value)` - aliases: `only`, `equal`](#anyvalidvalue---aliases-only-equal) - [`any.invalid(value)` - aliases: `disallow`, `not`](#anyinvalidvalue---aliases-disallow-not) - [`any.required()`](#anyrequired) - [`any.optional()`](#anyoptional) - [`any.forbidden()`](#anyforbidden) - [`any.strip()`](#anystrip) - [`any.description(desc)`](#anydescriptiondesc) - [`any.notes(notes)`](#anynotesnotes) - [`any.tags(tags)`](#anytagstags) - [`any.meta(meta)`](#anymetameta) - [`any.example(value)`](#anyexamplevalue) - [`any.unit(name)`](#anyunitname) - [`any.options(options)`](#anyoptionsoptions) - [`any.strict(isStrict)`](#anystrictisstrict) - [`any.default([value, [description]])`](#anydefaultvalue-description) - [`any.concat(schema)`](#anyconcatschema) - [`any.when(ref, options)`](#anywhenref-options) - [`any.label(name)`](#anylabelname) - [`any.raw(isRaw)`](#anyrawisraw) - [`any.empty(schema)`](#anyemptyschema) - [`array`](#array) - [`array.sparse(enabled)`](#arraysparseenabled) - [`array.single(enabled)`](#arraysingleenabled) - [`array.items(type)`](#arrayitemstype) - [`array.min(limit)`](#arrayminlimit) - [`array.max(limit)`](#arraymaxlimit) - [`array.length(limit)`](#arraylengthlimit) - [`array.unique()`](#arrayunique) - [`boolean`](#boolean) - [`binary`](#binary) - [`binary.encoding(encoding)`](#binaryencodingencoding) - [`binary.min(limit)`](#binaryminlimit) - [`binary.max(limit)`](#binarymaxlimit) - [`binary.length(limit)`](#binarylengthlimit) - [`date`](#date) - [`date.min(date)`](#datemindate) - [`date.max(date)`](#datemaxdate) - [`date.format(format)`](#dateformatformat) - [`date.iso()`](#dateiso) - [`func`](#func) - [`number`](#number) - [`number.min(limit)`](#numberminlimit) - [`number.max(limit)`](#numbermaxlimit) - [`number.greater(limit)`](#numbergreaterlimit) - [`number.less(limit)`](#numberlesslimit) - [`number.integer()`](#numberinteger) - [`number.precision(limit)`](#numberprecisionlimit) - [`number.multiple(base)`](#numbermultiplebase) - [`number.positive()`](#numberpositive) - [`number.negative()`](#numbernegative) - [`object`](#object) - [`object.keys([schema])`](#objectkeysschema) - [`object.min(limit)`](#objectminlimit) - [`object.max(limit)`](#objectmaxlimit) - [`object.length(limit)`](#objectlengthlimit) - [`object.pattern(regex, schema)`](#objectpatternregex-schema) - [`object.and(peers)`](#objectandpeers) - [`object.nand(peers)`](#objectnandpeers) - [`object.or(peers)`](#objectorpeers) - [`object.xor(peers)`](#objectxorpeers) - [`object.with(key, peers)`](#objectwithkey-peers) - [`object.without(key, peers)`](#objectwithoutkey-peers) - [`object.rename(from, to, [options])`](#objectrenamefrom-to-options) - [`object.assert(ref, schema, [message])`](#objectassertref-schema-message) - [`object.unknown([allow])`](#objectunknownallow) - [`object.type(constructor, [name])`](#objecttypeconstructor-name) - [`object.requiredKeys(children)`](#objectrequiredkeyschildren) - [`object.optionalKeys(children)`](#objectoptionalkeyschildren) - [`string`](#string) - [`string.insensitive()`](#stringinsensitive) - [`string.min(limit, [encoding])`](#stringminlimit-encoding) - [`string.max(limit, [encoding])`](#stringmaxlimit-encoding) - [`string.creditCard()`](#stringcreditcard) - [`string.length(limit, [encoding])`](#stringlengthlimit-encoding) - [`string.regex(pattern, [name])`](#stringregexpattern-name) - [`string.replace(pattern, replacement)`](#stringreplacepattern-replacement) - [`string.alphanum()`](#stringalphanum) - [`string.token()`](#stringtoken) - [`string.email([options])`](#stringemailoptions) - [`string.ip([options])`](#stringipoptions) - [`string.uri([options])`](#stringurioptions) - [`string.guid()`](#stringguid) - [`string.hex()`](#stringhex) - [`string.hostname()`](#stringhostname) - [`string.lowercase()`](#stringlowercase) - [`string.uppercase()`](#stringuppercase) - [`string.trim()`](#stringtrim) - [`string.isoDate()`](#stringisodate) - [`alternatives`](#alternatives) - [`alternatives.try(schemas)`](#alternativestryschemas) - [`alternatives.when(ref, options)`](#alternativeswhenref-options) - [`ref(key, [options])`](#refkey-options) <!-- tocstop --> # Example ```javascript var Joi = require('joi'); var schema = Joi.object().keys({ username: Joi.string().alphanum().min(3).max(30).required(), password: Joi.string().regex(/[a-zA-Z0-9]{3,30}/), access_token: [Joi.string(), Joi.number()], birthyear: Joi.number().integer().min(1900).max(2013), email: Joi.string().email() }).with('username', 'birthyear').without('password', 'access_token'); Joi.validate({ username: 'abc', birthyear: 1994 }, schema, function (err, value) { }); // err === null -> valid ``` The above schema defines the following constraints: * `username` * a required string * must contain only alphanumeric characters * at least 3 characters long but no more than 30 * must be accompanied by `birthyear` * `password` * an optional string * must satisfy the custom regex * cannot appear together with `access_token` * `access_token` * an optional, unconstrained string or number * `birthyear` * an integer between 1900 and 2013 * `email` * a valid email address string # Usage Usage is a two steps process. First, a schema is constructed using the provided types and constraints: ```javascript var schema = { a: Joi.string() }; ``` Note that **joi** schema objects are immutable which means every additional rule added (e.g. `.min(5)`) will return a new schema object. Then the value is validated against the schema: ```javascript Joi.validate({ a: 'a string' }, schema, function (err, value) { }); ``` If the value is valid, `null` is returned, otherwise an `Error` object. The schema can be a plain JavaScript object where every key is assigned a **joi** type, or it can be a **joi** type directly: ```javascript var schema = Joi.string().min(10); ``` If the schema is a **joi** type, the `schema.validate(value, callback)` can be called directly on the type. When passing a non-type schema object, the module converts it internally to an object() type equivalent to: ```javascript var schema = Joi.object().keys({ a: Joi.string() }); ``` When validating a schema: * Keys are optional by default. * Strings are utf-8 encoded by default. * Rules are defined in an additive fashion and evaluated in order after whitelist and blacklist checks. ### `validate(val