Skip to content

Commit 31089bb

Browse files
authored
Merge pull request #1165 from rokoroku/patch-api-md
Add missing documentation for any.validate() in API.md
2 parents 5450404 + 8a86908 commit 31089bb

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

API.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- [npm note](#npm-note)
2222
- [Examples](#examples)
2323
- [`any`](#any)
24+
- [`any.validate(value, [options], [callback])`](#anyvalidatevalue-options-callback)
2425
- [`any.allow(value)`](#anyallowvalue)
2526
- [`any.valid(value)` - aliases: `only`, `equal`](#anyvalidvalue---aliases-only-equal)
2627
- [`any.invalid(value)` - aliases: `disallow`, `not`](#anyinvalidvalue---aliases-disallow-not)
@@ -392,6 +393,32 @@ const any = Joi.any();
392393
any.validate('a', (err, value) => { });
393394
```
394395

396+
#### `any.validate(value, [options], [callback])`
397+
398+
Validates a value using the schema and options where:
399+
- `value` - the value being validated.
400+
- `options` - an object with the same optional keys as [`Joi.validate(value, schema, options, callback)`](#validatevalue-schema-options-callback).
401+
- `callback` - an optional synchronous callback method using the the same signature as [`Joi.validate(value, schema, options, callback)`](#validatevalue-schema-options-callback).
402+
403+
```js
404+
const schema = Joi.object({
405+
a: Joi.number()
406+
});
407+
408+
const value = {
409+
a: '123'
410+
};
411+
412+
schema.validate(value, (err, value) => { });
413+
// err -> null
414+
// value.a -> 123 (number, not string)
415+
416+
// or
417+
const result = schema.validate(value, schema);
418+
// result.error -> null
419+
// result.value -> { "a" : 123 }
420+
```
421+
395422
#### `any.allow(value)`
396423

397424
Whitelists a value where:

0 commit comments

Comments
 (0)