Skip to content

Commit

Permalink
Remove TOC from API
Browse files Browse the repository at this point in the history
  • Loading branch information
jarrodyellets committed Sep 26, 2019
1 parent 4e7ce1c commit 570fb75
Showing 1 changed file with 0 additions and 309 deletions.
309 changes: 0 additions & 309 deletions API.md
Original file line number Diff line number Diff line change
@@ -1,313 +1,4 @@

<!-- toc -->

- [joi](#joi)
- [`assert(value, schema, [message], [options])`](#assertvalue-schema-message-options)
- [`attempt(value, schema, [message], [options])`](#attemptvalue-schema-message-options)
- [`cache.provision([options])`](#cacheprovisionoptions)
- [`checkPreferences(prefs)`](#checkpreferencesprefs)
- [`compile(schema, [options])`](#compileschema-options)
- [`defaults(modifier)`](#defaultsmodifier)
- [`expression(template, [options])` - aliases: `x`](#expressiontemplate-options---aliases-x)
- [Template syntax](#template-syntax)
- [`extend(...extensions)`](#extendextensions)
- [`isExpression(expression)`](#isexpressionexpression)
- [`in(ref, [options])`](#inref-options)
- [`isRef(ref)`](#isrefref)
- [`isSchema(schema, [options])`](#isschemaschema-options)
- [`override`](#override)
- [`ref(key, [options])`](#refkey-options)
- [Relative references](#relative-references)
- [`version`](#version)
- [`types()`](#types)
- [`any`](#any)
- [`any.type`](#anytype)
- [`any.allow(...values)`](#anyallowvalues)
- [`any.alter(targets)`](#anyaltertargets)
- [`any.cache([cache])`](#anycachecache)
- [Cache interface](#cache-interface)
- [`any.cast(to)`](#anycastto)
- [`any.concat(schema)`](#anyconcatschema)
- [`any.custom(method, [description])`](#anycustommethod-description)
- [`any.default([value])`](#anydefaultvalue)
- [`any.describe()`](#anydescribe)
- [`any.description(desc)`](#anydescriptiondesc)
- [`any.empty(schema)`](#anyemptyschema)
- [`any.error(err)`](#anyerrorerr)
- [`any.example(example, [options])`](#anyexampleexample-options)
- [`any.external(method, [description])`](#anyexternalmethod-description)
- [`any.extract(path)`](#anyextractpath)
- [`any.failover(value)`](#anyfailovervalue)
- [`any.forbidden()`](#anyforbidden)
- [`any.fork(paths, adjuster)`](#anyforkpaths-adjuster)
- [`any.id(id)`](#anyidid)
- [`any.invalid(...values)` - aliases: `disallow`, `not`](#anyinvalidvalues---aliases-disallow-not)
- [`any.keep()`](#anykeep)
- [`any.label(name)`](#anylabelname)
- [`any.message(message)`](#anymessagemessage)
- [`any.messages(messages)`](#anymessagesmessages)
- [`any.meta(meta)`](#anymetameta)
- [`any.note(...notes)`](#anynotenotes)
- [`any.only()`](#anyonly)
- [`any.optional()`](#anyoptional)
- [`any.prefs(options)` - aliases: `preferences`, `options`](#anyprefsoptions---aliases-preferences-options)
- [`any.presence(mode)`](#anypresencemode)
- [`any.raw([enabled])`](#anyrawenabled)
- [`any.required()` - aliases: `exist`](#anyrequired---aliases-exist)
- [`any.result(mode)`](#anyresultmode)
- [`any.rule(options)`](#anyruleoptions)
- [`any.ruleset` - aliases: `$`](#anyruleset---aliases-)
- [`any.shared(schema)`](#anysharedschema)
- [`any.strict(isStrict)`](#anystrictisstrict)
- [`any.strip([enabled])`](#anystripenabled)
- [`any.tag(...tags)`](#anytagtags)
- [`any.tailor(targets)`](#anytailortargets)
- [`any.unit(name)`](#anyunitname)
- [`any.valid(...values)` - aliases: `equal`](#anyvalidvalues---aliases-equal)
- [`any.validate(value, [options])`](#anyvalidatevalue-options)
- [`any.validateAsync(value, [options])`](#anyvalidateasyncvalue-options)
- [`any.warn()`](#anywarn)
- [`any.warning(code, [context])`](#anywarningcode-context)
- [`any.when([condition], options)`](#anywhencondition-options)
- [`alternatives`](#alternatives)
- [`alternatives.conditional(condition, options)`](#alternativesconditionalcondition-options)
- [`alternatives.match(mode)`](#alternativesmatchmode)
- [`alternatives.try(...schemas)`](#alternativestryschemas)
- [`array`](#array)
- [`array.has(schema)`](#arrayhasschema)
- [`array.items(...types)`](#arrayitemstypes)
- [`array.length(limit)`](#arraylengthlimit)
- [`array.max(limit)`](#arraymaxlimit)
- [`array.min(limit)`](#arrayminlimit)
- [`array.ordered(...type)`](#arrayorderedtype)
- [`array.single([enabled])`](#arraysingleenabled)
- [`array.sort([options])`](#arraysortoptions)
- [`array.sparse([enabled])`](#arraysparseenabled)
- [`array.unique([comparator, [options]])`](#arrayuniquecomparator-options)
- [`binary`](#binary)
- [`binary.encoding(encoding)`](#binaryencodingencoding)
- [`binary.length(limit)`](#binarylengthlimit)
- [`binary.max(limit)`](#binarymaxlimit)
- [`binary.min(limit)`](#binaryminlimit)
- [`boolean`](#boolean)
- [`boolean.falsy(...values)`](#booleanfalsyvalues)
- [`boolean.sensitive([enabled])`](#booleansensitiveenabled)
- [`boolean.truthy(...values)`](#booleantruthyvalues)
- [`date`](#date)
- [`date.greater(date)`](#dategreaterdate)
- [`date.iso()`](#dateiso)
- [`date.less(date)`](#datelessdate)
- [`date.max(date)`](#datemaxdate)
- [`date.min(date)`](#datemindate)
- [`date.timestamp([type])`](#datetimestamptype)
- [`function` - inherits from `object`](#function---inherits-from-object)
- [`function.arity(n)`](#functionarityn)
- [`function.class()`](#-functionclass)
- [`function.maxArity(n)`](#-functionmaxarityn)
- [`function.minArity(n)`](#-functionminarityn)
- [`link(ref)`](#linkref)
- [`link.ref(ref)`](#linkrefref)
- [`link.concat(schema)`](#linkconcatschema)
- [`number`](#number)
- [`number.greater(limit)`](#numbergreaterlimit)
- [`number.integer()`](#numberinteger)
- [`number.less(limit)`](#numberlesslimit)
- [`number.max(limit)`](#numbermaxlimit)
- [`number.min(limit)`](#numberminlimit)
- [`number.multiple(base)`](#numbermultiplebase)
- [`number.negative()`](#numbernegative)
- [`number.port()`](#numberport)
- [`number.positive()`](#numberpositive)
- [`number.precision(limit)`](#numberprecisionlimit)
- [`number.sign(sign)`](#numbersignsign)
- [`number.unsafe([enabled])`](#numberunsafeenabled)
- [`object`](#object)
- [`object.and(...peers, [options])`](#objectandpeers-options)
- [`object.append([schema])`](#objectappendschema)
- [`object.assert(subject, schema, [message])`](#objectassertsubject-schema-message)
- [`object.instance(constructor, [name])`](#objectinstanceconstructor-name)
- [`object.keys([schema])`](#objectkeysschema)
- [`object.length(limit)`](#objectlengthlimit)
- [`object.max(limit)`](#objectmaxlimit)
- [`object.min(limit)`](#objectminlimit)
- [`object.nand(...peers, [options])`](#objectnandpeers-options)
- [`object.or(...peers, [options])`](#objectorpeers-options)
- [`object.oxor(...peers, [options])`](#objectoxorpeers-options)
- [`object.pattern(pattern, schema, [options])`](#objectpatternpattern-schema-options)
- [`object.ref()`](#objectref)
- [`object.rename(from, to, [options])`](#objectrenamefrom-to-options)
- [`object.schema([type])`](#objectschematype)
- [`object.unknown([allow])`](#objectunknownallow)
- [`object.with(key, peers, [options])`](#objectwithkey-peers-options)
- [`object.without(key, peers, [options])`](#objectwithoutkey-peers-options)
- [`object.xor(...peers, [options])`](#objectxorpeers-options)
- [`string`](#string)
- [`string.alphanum()`](#stringalphanum)
- [`string.base64([options])`](#stringbase64options)
- [`string.case(direction)`](#stringcasedirection)
- [`string.creditCard()`](#stringcreditcard)
- [`string.dataUri([options])`](#stringdataurioptions)
- [`string.domain([options])`](#stringdomainoptions)
- [`string.email([options])`](#stringemailoptions)
- [`string.guid()` - aliases: `uuid`](#stringguid---aliases-uuid)
- [`string.hex([options])`](#stringhexoptions)
- [`string.hostname()`](#stringhostname)
- [`string.insensitive()`](#stringinsensitive)
- [`string.ip([options])`](#stringipoptions)
- [`string.isoDate()`](#stringisodate)
- [`string.isoDuration()`](#stringisoduration)
- [`string.length(limit, [encoding])`](#stringlengthlimit-encoding)
- [`string.lowercase()`](#stringlowercase)
- [`string.max(limit, [encoding])`](#stringmaxlimit-encoding)
- [`string.min(limit, [encoding])`](#stringminlimit-encoding)
- [`string.normalize([form])`](#stringnormalizeform)
- [`string.pattern(regex, [name | options])` - aliases: `regex`](#stringpatternregex-name--options---aliases-regex)
- [`string.replace(pattern, replacement)`](#stringreplacepattern-replacement)
- [`string.token()`](#stringtoken)
- [`string.trim([enabled])`](#stringtrimenabled)
- [`string.truncate([enabled])`](#stringtruncateenabled)
- [`string.uppercase()`](#stringuppercase)
- [`string.uri([options])`](#stringurioptions)
- [`symbol`](#symbol)
- [`symbol.map(map)`](#symbolmapmap)
- [Extensions](#extensions)
- [Advanced functions](#advanced-functions)
- [$_root](#_root)
- [$_super](#_super)
- [$_temp](#_temp)
- [$_terms](#_terms)
- [$_addRule(options)](#_addruleoptions)
- [$_compile(schema, options)](#_compileschema-options)
- [$_createError(code, value, local, state, prefs, options)](#_createerrorcode-value-local-state-prefs-options)
- [$_getFlag(name)](#_getflagname)
- [$_getRule(name)](#_getrulename)
- [$_mapLabels(path)](#_maplabelspath)
- [$_match(value, state, prefs, overrides)](#_matchvalue-state-prefs-overrides)
- [$_modify(options)](#_modifyoptions)
- [$_mutateRebuild()](#_mutaterebuild)
- [$_mutateRegister(schema, options)](#_mutateregisterschema-options)
- [$_property(name)](#_propertyname)
- [$_reach(path)](#_reachpath)
- [$_rootReferences()](#_rootreferences)
- [$_setFlag(name, value, options)](#_setflagname-value-options)
- [$_validate(value, state, prefs)](#_validatevalue-state-prefs)
- [Errors](#errors)
- [`ValidationError`](#validationerror)
- [List of errors](#list-of-errors)
- [`alternatives.all`](#alternativesall)
- [`alternatives.any`](#alternativesany)
- [`alternatives.match`](#alternativesmatch)
- [`alternatives.one`](#alternativesone)
- [`alternatives.types`](#alternativestypes)
- [`any.custom`](#anycustom)
- [`any.default`](#anydefault)
- [`any.failover`](#anyfailover)
- [`any.invalid`](#anyinvalid)
- [`any.only`](#anyonly-1)
- [`any.ref`](#anyref)
- [`any.required`](#anyrequired)
- [`any.unknown`](#anyunknown)
- [`array.base`](#arraybase)
- [`array.excludes`](#arrayexcludes)
- [`array.includesRequiredBoth`](#arrayincludesrequiredboth)
- [`array.includesRequiredKnowns`](#arrayincludesrequiredknowns)
- [`array.includesRequiredUnknowns`](#arrayincludesrequiredunknowns)
- [`array.includes`](#arrayincludes)
- [`array.length`](#arraylength)
- [`array.max`](#arraymax)
- [`array.min`](#arraymin)
- [`array.orderedLength`](#arrayorderedlength)
- [`array.sort`](#arraysort)
- [`array.sort.mismatching`](#arraysortmismatching)
- [`array.sort.unsupported`](#arraysortunsupported)
- [`array.sparse`](#arraysparse)
- [`array.unique`](#arrayunique)
- [`array.hasKnown`](#arrayhasknown)
- [`array.hasUnknown`](#arrayhasunknown)
- [`binary.base`](#binarybase)
- [`binary.length`](#binarylength)
- [`binary.max`](#binarymax)
- [`binary.min`](#binarymin)
- [`boolean.base`](#booleanbase)
- [`date.base`](#datebase)
- [`date.format`](#dateformat)
- [`date.greater`](#dategreater)
- [`date.less`](#dateless)
- [`date.max`](#datemax)
- [`date.min`](#datemin)
- [`date.strict`](#datestrict)
- [`function.arity`](#functionarity)
- [`function.class`](#functionclass)
- [`function.maxArity`](#functionmaxarity)
- [`function.minArity`](#functionminarity)
- [`number.base`](#numberbase)
- [`number.greater`](#numbergreater)
- [`number.infinity`](#numberinfinity)
- [`number.integer`](#numberinteger-1)
- [`number.less`](#numberless)
- [`number.max`](#numbermax)
- [`number.min`](#numbermin)
- [`number.multiple`](#numbermultiple)
- [`number.negative`](#numbernegative-1)
- [`number.port`](#numberport-1)
- [`number.positive`](#numberpositive-1)
- [`number.precision`](#numberprecision)
- [`number.unsafe`](#numberunsafe)
- [`object.unknown`](#objectunknown)
- [`object.and`](#objectand)
- [`object.assert`](#objectassert)
- [`object.base`](#objectbase)
- [`object.length`](#objectlength)
- [`object.max`](#objectmax)
- [`object.min`](#objectmin)
- [`object.missing`](#objectmissing)
- [`object.nand`](#objectnand)
- [`object.pattern.match`](#objectpatternmatch)
- [`object.rename.override`](#objectrenameoverride)
- [`object.schema`](#objectschema)
- [`object.instance`](#objectinstance)
- [`object.with`](#objectwith)
- [`object.without`](#objectwithout)
- [`object.xor`](#objectxor)
- [`object.oxor`](#objectoxor)
- [`string.alphanum`](#stringalphanum-1)
- [`string.base64`](#stringbase64)
- [`string.base`](#stringbase)
- [`string.creditCard`](#stringcreditcard-1)
- [`string.dataUri`](#stringdatauri)
- [`string.domain`](#stringdomain)
- [`string.email`](#stringemail)
- [`string.empty`](#stringempty)
- [`string.guid`](#stringguid)
- [`string.hexAlign`](#stringhexalign)
- [`string.hex`](#stringhex)
- [`string.hostname`](#stringhostname-1)
- [`string.ipVersion`](#stringipversion)
- [`string.ip`](#stringip)
- [`string.isoDate`](#stringisodate-1)
- [`string.isoDuration`](#stringisoduration-1)
- [`string.length`](#stringlength)
- [`string.lowercase`](#stringlowercase-1)
- [`string.max`](#stringmax)
- [`string.min`](#stringmin)
- [`string.normalize`](#stringnormalize)
- [`string.pattern.base`](#stringpatternbase)
- [`string.pattern.name`](#stringpatternname)
- [`string.pattern.invert.base`](#stringpatterninvertbase)
- [`string.pattern.invert.name`](#stringpatterninvertname)
- [`string.token`](#stringtoken-1)
- [`string.trim`](#stringtrim)
- [`string.uppercase`](#stringuppercase-1)
- [`string.uri`](#stringuri)
- [`string.uriCustomScheme`](#stringuricustomscheme)
- [`string.uriRelativeOnly`](#stringurirelativeonly)
- [`symbol.base`](#symbolbase)
- [`symbol.map`](#symbolmap)

<!-- tocstop -->

## joi

### `assert(value, schema, [message], [options])`

Validates a value against a schema and [throws](#errors) if validation fails where:
Expand Down

0 comments on commit 570fb75

Please sign in to comment.