\n : PartialSchemaMap;\n\n type Schema =\n | AnySchema
\n | ArraySchema
\n | AlternativesSchema
\n | BinarySchema
\n | BooleanSchema
\n | DateSchema
\n | FunctionSchema
\n | NumberSchema
\n | ObjectSchema
\n | StringSchema
\n | LinkSchema
\n | SymbolSchema
;\n\n type SchemaFunction = (schema: Schema) => Schema;\n\n interface AddRuleOptions {\n name: string;\n args?: {\n [key: string]: any;\n };\n }\n\n interface GetRuleOptions {\n args?: Record;\n method?: string;\n name: string;\n operator?: string;\n }\n\n interface SchemaInternals {\n /**\n * Parent schema object.\n */\n $_super: Schema;\n\n /**\n * Terms of current schema.\n */\n $_terms: Record;\n\n /**\n * Adds a rule to current validation schema.\n */\n $_addRule(rule: string | AddRuleOptions): Schema;\n\n /**\n * Internally compiles schema.\n */\n $_compile(schema: SchemaLike, options?: CompileOptions): Schema;\n\n /**\n * Creates a joi error object.\n */\n $_createError(\n code: string,\n value: any,\n context: Context,\n state: State,\n prefs: ValidationOptions,\n options?: CreateErrorOptions\n ): Err;\n\n /**\n * Get value from given flag.\n */\n $_getFlag(name: string): any;\n\n /**\n * Retrieve some rule configuration.\n */\n $_getRule(name: string): GetRuleOptions | undefined;\n\n $_mapLabels(path: string | string[]): string;\n\n /**\n * Returns true if validations runs fine on given value.\n */\n $_match(value: any, state: State, prefs: ValidationOptions): boolean;\n\n $_modify(options?: ModifyOptions): Schema;\n\n /**\n * Resets current schema.\n */\n $_mutateRebuild(): this;\n\n $_mutateRegister(schema: Schema, options?: MutateRegisterOptions): void;\n\n /**\n * Get value from given property.\n */\n $_property(name: string): any;\n\n /**\n * Get schema at given path.\n */\n $_reach(path: string[]): Schema;\n\n /**\n * Get current schema root references.\n */\n $_rootReferences(): any;\n\n /**\n * Set flag to given value.\n */\n $_setFlag(flag: string, value: any, options?: SetFlagOptions): void;\n\n /**\n * Runs internal validations against given value.\n */\n $_validate(\n value: any,\n state: State,\n prefs: ValidationOptions\n ): ValidationResult;\n }\n\n interface AnySchema\n extends SchemaInternals,\n StandardSchemaV1 {\n /**\n * Flags of current schema.\n */\n _flags: Record;\n\n /**\n * Starts a ruleset in order to apply multiple rule options. The set ends when `rule()`, `keep()`, `message()`, or `warn()` is called.\n */\n $: this;\n\n /**\n * Starts a ruleset in order to apply multiple rule options. The set ends when `rule()`, `keep()`, `message()`, or `warn()` is called.\n */\n ruleset: this;\n\n type?: Types | string;\n\n /**\n * Whitelists a value\n */\n allow(...values: any[]): this;\n\n /**\n * Assign target alteration options to a schema that are applied when `any.tailor()` is called.\n * @param targets - an object where each key is a target name, and each value is a function that takes an schema and returns an schema.\n */\n alter(targets: Record Schema>): this;\n\n /**\n * Assigns the schema an artifact id which is included in the validation result if the rule passed validation.\n * @param id - any value other than undefined which will be returned as-is in the result artifacts map.\n */\n artifact(id: any): this;\n\n /**\n * By default, some Joi methods to function properly need to rely on the Joi instance they are attached to because\n * they use `this` internally.\n * So `Joi.string()` works but if you extract the function from it and call `string()` it won't.\n * `bind()` creates a new Joi instance where all the functions relying on `this` are bound to the Joi instance.\n */\n bind(): this;\n\n /**\n * Adds caching to the schema which will attempt to cache the validation results (success and failures) of incoming inputs.\n * If no cache is passed, a default cache is provisioned by using `cache.provision()` internally.\n */\n cache(cache?: Cache): this;\n\n /**\n * Casts the validated value to the specified type.\n */\n cast(to: \"map\" | \"number\" | \"set\" | \"string\"): this;\n\n /**\n * Returns a new type that is the result of adding the rules of one type to another.\n */\n concat(schema: this): this;\n\n /**\n * Adds a custom validation function.\n */\n custom(fn: CustomValidator, description?: string): this;\n\n /**\n * Sets a default value if the original value is `undefined` where:\n * @param value - the default value. One of:\n * - a literal value (string, number, object, etc.)\n * - a [references](#refkey-options)\n * - a function which returns the default value using the signature `function(parent, helpers)` where:\n * - `parent` - a clone of the object containing the value being validated. Note that since specifying a\n * `parent` argument performs cloning, do not declare format arguments if you are not using them.\n * - `helpers` - same as those described in [`any.custom()`](anycustomermethod_description)\n *\n * When called without any `value` on an object schema type, a default value will be automatically generated\n * based on the default values of the object keys.\n *\n * Note that if value is an object, any changes to the object after `default()` is called will change the\n * reference and any future assignment.\n */\n default(\n value?:\n | BasicType\n | Reference\n | ((parent: any, helpers: CustomHelpers) => BasicType | Reference)\n ): this;\n\n /**\n * Returns a plain object representing the schema's rules and properties\n */\n describe(): Description;\n\n /**\n * Annotates the key\n */\n description(desc: string): this;\n\n /**\n * Disallows values.\n */\n disallow(...values: any[]): this;\n\n /**\n * Considers anything that matches the schema to be empty (undefined). Overrides any previous calls to empty.\n * @param schema - an object, value, or joi schema to match or an array of objects, values, and joi schemas to match. An undefined schema unsets that rule.\n */\n empty(schema?: SchemaLike): this;\n\n /**\n * Adds the provided values into the allowed whitelist and marks them as the only valid values allowed.\n */\n equal(...values: any[]): this;\n\n /**\n * Overrides the default joi error with a custom error if the rule fails where:\n * @param err - can be:\n * an instance of `Error` - the override error.\n * a `function(errors)`, taking an array of errors as argument, where it must either:\n * return a `string` - substitutes the error message with this text\n * return a single ` object` or an `Array` of it, where:\n * `type` - optional parameter providing the type of the error (eg. `number.min`).\n * `message` - optional parameter if `template` is provided, containing the text of the error.\n * `template` - optional parameter if `message` is provided, containing a template string, using the same format as usual joi language errors.\n * `context` - optional parameter, to provide context to your error if you are using the `template`.\n * return an `Error` - same as when you directly provide an `Error`, but you can customize the error message based on the errors.\n *\n * Note that if you provide an `Error`, it will be returned as-is, unmodified and undecorated with any of the\n * normal joi error properties. If validation fails and another error is found before the error\n * override, that error will be returned and the override will be ignored (unless the `abortEarly`\n * option has been set to `false`).\n */\n error(err: Error | ValidationErrorFunction): this;\n\n /**\n * Annotates the key with an example value, must be valid.\n */\n example(value: any, options?: { override: boolean }): this;\n\n /**\n * Marks a key as required which will not allow undefined as value. All keys are optional by default.\n */\n exist(): this;\n\n /**\n * Adds an external validation rule.\n *\n * Note that external validation rules are only called after the all other validation rules for the entire schema (from the value root) are checked.\n * This means that any changes made to the value by the external rules are not available to any other validation rules during the non-external validation phase.\n * If schema validation failed, no external validation rules are called.\n */\n external(method: ExternalValidationFunction, description?: string): this;\n\n /**\n * Returns a sub-schema based on a path of object keys or schema ids.\n *\n * @param path - a dot `.` separated path string or a pre-split array of path keys. The keys must match the sub-schema id or object key (if no id was explicitly set).\n */\n extract(path: string | string[]): Schema;\n\n /**\n * Sets a failover value if the original value fails passing validation.\n *\n * @param value - the failover value. value supports references. value may be assigned a function which returns the default value.\n *\n * If value is specified as a function that accepts a single parameter, that parameter will be a context object that can be used to derive the resulting value.\n * Note that if value is an object, any changes to the object after `failover()` is called will change the reference and any future assignment.\n * Use a function when setting a dynamic value (e.g. the current time).\n * Using a function with a single argument performs some internal cloning which has a performance impact.\n * If you do not need access to the context, define the function without any arguments.\n */\n failover(value: any): this;\n\n /**\n * Marks a key as forbidden which will not allow any value except undefined. Used to explicitly forbid keys.\n */\n forbidden(): this;\n\n /**\n * Returns a new schema where each of the path keys listed have been modified.\n *\n * @param key - an array of key strings, a single key string, or an array of arrays of pre-split key strings.\n * @param adjuster - a function which must return a modified schema.\n */\n fork(key: string | string[] | string[][], adjuster: SchemaFunction): this;\n\n /**\n * Sets a schema id for reaching into the schema via `any.extract()`.\n * If no id is set, the schema id defaults to the object key it is associated with.\n * If the schema is used in an array or alternatives type and no id is set, the schema in unreachable.\n */\n id(name?: string): this;\n\n /**\n * Disallows values.\n */\n invalid(...values: any[]): this;\n\n /**\n * Returns a boolean indicating whether this schema contains a rule that requires asynchronous validation.\n */\n isAsync(): boolean;\n\n /**\n * Same as `rule({ keep: true })`.\n *\n * Note that `keep()` will terminate the current ruleset and cannot be followed by another rule option.\n * Use `rule()` to apply multiple rule options.\n */\n keep(): this;\n\n /**\n * Overrides the key name in error messages.\n */\n label(name: string): this;\n\n /**\n * Same as `rule({ message })`.\n *\n * Note that `message()` will terminate the current ruleset and cannot be followed by another rule option.\n * Use `rule()` to apply multiple rule options.\n */\n message(message: string): this;\n\n /**\n * Same as `any.prefs({ messages })`.\n * Note that while `any.message()` applies only to the last rule or ruleset, `any.messages()` applies to the entire schema.\n */\n messages(messages: LanguageMessages): this;\n\n /**\n * Attaches metadata to the key.\n */\n meta(meta: object): this;\n\n /**\n * Disallows values.\n */\n not(...values: any[]): this;\n\n /**\n * Annotates the key\n */\n note(...notes: string[]): this;\n\n /**\n * Requires the validated value to match of the provided `any.allow()` values.\n * It has not effect when called together with `any.valid()` since it already sets the requirements.\n * When used with `any.allow()` it converts it to an `any.valid()`.\n */\n only(): this;\n\n /**\n * Marks a key as optional which will allow undefined as values. Used to annotate the schema for readability as all keys are optional by default.\n */\n optional(): this;\n\n /**\n * Overrides the global validate() options for the current key and any sub-key.\n */\n options(options: ValidationOptions): this;\n\n /**\n * Overrides the global validate() options for the current key and any sub-key.\n */\n prefs(options: ValidationOptions): this;\n\n /**\n * Overrides the global validate() options for the current key and any sub-key.\n */\n preferences(options: ValidationOptions): this;\n\n /**\n * Sets the presence mode for the schema.\n */\n presence(mode: PresenceMode): this;\n\n /**\n * Outputs the original untouched value instead of the casted value.\n */\n raw(enabled?: boolean): this;\n\n /**\n * Marks a key as required which will not allow undefined as value. All keys are optional by default.\n */\n required(): this;\n\n /**\n * Applies a set of rule options to the current ruleset or last rule added.\n *\n * When applying rule options, the last rule (e.g. `min()`) is used unless there is an active ruleset defined (e.g. `$.min().max()`)\n * in which case the options are applied to all the provided rules.\n * Once `rule()` is called, the previous rules can no longer be modified and any active ruleset is terminated.\n *\n * Rule modifications can only be applied to supported rules.\n * Most of the `any` methods do not support rule modifications because they are implemented using schema flags (e.g. `required()`) or special\n * internal implementation (e.g. `valid()`).\n * In those cases, use the `any.messages()` method to override the error codes for the errors you want to customize.\n */\n rule(options: RuleOptions): this;\n\n /**\n * Registers a schema to be used by descendants of the current schema in named link references.\n */\n shared(ref: Schema): this;\n\n /**\n * Sets the options.convert options to false which prevent type casting for the current key and any child keys.\n */\n strict(isStrict?: boolean): this;\n\n /**\n * Marks a key to be removed from a resulting object or array after validation. Used to sanitize output.\n * @param [enabled=true] - if true, the value is stripped, otherwise the validated value is retained. Defaults to true.\n */\n strip(enabled?: boolean): this;\n\n /**\n * Annotates the key\n */\n tag(...tags: string[]): this;\n\n /**\n * Applies any assigned target alterations to a copy of the schema that were applied via `any.alter()`.\n */\n tailor(targets: string | string[]): Schema;\n\n /**\n * Annotates the key with an unit name.\n */\n unit(name: string): this;\n\n /**\n * Adds the provided values into the allowed whitelist and marks them as the only valid values allowed.\n */\n valid(...values: any[]): this;\n\n /**\n * Validates a value using the schema and options.\n */\n validate(\n value: any,\n options?: ValidationOptions\n ): ValidationResult;\n\n /**\n * Validates a value using the schema and options.\n */\n validateAsync(\n value: any,\n options?: TOpts\n ): Promise<\n TOpts extends { artifacts: true } | { warnings: true }\n ? { value: TSchema } & (TOpts extends { artifacts: true }\n ? { artifacts: Map }\n : {}) &\n (TOpts extends { warnings: true }\n ? { warning: ValidationWarning }\n : {})\n : TSchema\n >;\n\n /**\n * Same as `rule({ warn: true })`.\n * Note that `warn()` will terminate the current ruleset and cannot be followed by another rule option.\n * Use `rule()` to apply multiple rule options.\n */\n warn(): this;\n\n /**\n * Generates a warning.\n * When calling `any.validateAsync()`, set the `warning` option to true to enable warnings.\n * Warnings are reported separately from errors alongside the result value via the warning key (i.e. `{ value, warning }`).\n * Warning are always included when calling `any.validate()`.\n */\n warning(code: string, context: Context): this;\n\n /**\n * Converts the type into an alternatives type where the conditions are merged into the type definition where:\n */\n when(ref: string | Reference, options: WhenOptions | WhenOptions[]): this;\n\n /**\n * Converts the type into an alternatives type where the conditions are merged into the type definition where:\n */\n when(ref: Schema, options: WhenSchemaOptions): this;\n }\n\n interface Description {\n type?: Types | string;\n label?: string;\n description?: string;\n flags?: object;\n notes?: string[];\n tags?: string[];\n metas?: any[];\n example?: any[];\n valids?: any[];\n invalids?: any[];\n unit?: string;\n options?: ValidationOptions;\n [key: string]: any;\n }\n\n interface Context {\n [key: string]: any;\n key?: string;\n label?: string;\n value?: any;\n }\n\n interface State {\n key?: string;\n path?: (string | number)[];\n parent?: any;\n reference?: any;\n ancestors?: any;\n localize?(...args: any[]): State;\n }\n\n interface BooleanSchema extends AnySchema {\n /**\n * Allows for additional values to be considered valid booleans by converting them to false during validation.\n * String comparisons are by default case insensitive,\n * see `boolean.sensitive()` to change this behavior.\n * @param values - strings, numbers or arrays of them\n */\n falsy(...values: Array): this;\n\n /**\n * Allows the values provided to truthy and falsy as well as the \"true\" and \"false\" default conversion\n * (when not in `strict()` mode) to be matched in a case insensitive manner.\n */\n sensitive(enabled?: boolean): this;\n\n /**\n * Allows for additional values to be considered valid booleans by converting them to true during validation.\n * String comparisons are by default case insensitive, see `boolean.sensitive()` to change this behavior.\n * @param values - strings, numbers or arrays of them\n */\n truthy(...values: Array): this;\n }\n\n interface NumberSchema extends AnySchema {\n /**\n * Specifies that the value must be greater than limit.\n * It can also be a reference to another field.\n */\n greater(limit: number | Reference): this;\n\n /**\n * Requires the number to be an integer (no floating point).\n */\n integer(): this;\n\n /**\n * Specifies that the value must be less than limit.\n * It can also be a reference to another field.\n */\n less(limit: number | Reference): this;\n\n /**\n * Specifies the maximum value.\n * It can also be a reference to another field.\n */\n max(limit: number | Reference): this;\n\n /**\n * Specifies the minimum value.\n * It can also be a reference to another field.\n */\n min(limit: number | Reference): this;\n\n /**\n * Specifies that the value must be a multiple of base.\n */\n multiple(base: number | Reference): this;\n\n /**\n * Requires the number to be negative.\n */\n negative(): this;\n\n /**\n * Requires the number to be a TCP port, so between 0 and 65535.\n */\n port(): this;\n\n /**\n * Requires the number to be positive.\n */\n positive(): this;\n\n /**\n * Specifies the maximum number of decimal places where:\n * @param limit - the maximum number of decimal places allowed.\n */\n precision(limit: number): this;\n\n /**\n * Requires the number to be negative or positive.\n */\n sign(sign: \"positive\" | \"negative\"): this;\n\n /**\n * Allows the number to be outside of JavaScript's safety range (Number.MIN_SAFE_INTEGER & Number.MAX_SAFE_INTEGER).\n */\n unsafe(enabled?: any): this;\n }\n\n interface StringSchema extends AnySchema {\n /**\n * Requires the string value to only contain a-z, A-Z, and 0-9.\n */\n alphanum(): this;\n\n /**\n * Requires the string value to be a valid base64 string; does not check the decoded value.\n */\n base64(options?: Base64Options): this;\n\n /**\n * Sets the required string case.\n */\n case(direction: \"upper\" | \"lower\"): this;\n\n /**\n * Requires the number to be a credit card number (Using Luhn Algorithm).\n */\n creditCard(): this;\n\n /**\n * Requires the string value to be a valid data URI string.\n */\n dataUri(options?: DataUriOptions): this;\n\n /**\n * Requires the string value to be a valid domain.\n */\n domain(options?: DomainOptions): this;\n\n /**\n * Requires the string value to be a valid email address.\n */\n email(options?: EmailOptions): this;\n\n /**\n * Requires the string value to be a valid GUID.\n */\n guid(options?: GuidOptions): this;\n\n /**\n * Requires the string value to be a valid hexadecimal string.\n */\n hex(options?: HexOptions): this;\n\n /**\n * Requires the string value to be a valid hostname as per RFC1123.\n */\n hostname(): this;\n\n /**\n * Allows the value to match any whitelist of blacklist item in a case insensitive comparison.\n */\n insensitive(): this;\n\n /**\n * Requires the string value to be a valid ip address.\n */\n ip(options?: IpOptions): this;\n\n /**\n * Requires the string value to be in valid ISO 8601 date format.\n */\n isoDate(): this;\n\n /**\n * Requires the string value to be in valid ISO 8601 duration format.\n */\n isoDuration(): this;\n\n /**\n * Specifies the exact string length required\n * @param limit - the required string length. It can also be a reference to another field.\n * @param encoding - if specified, the string length is calculated in bytes using the provided encoding.\n */\n length(limit: number | Reference, encoding?: string): this;\n\n /**\n * Requires the string value to be all lowercase. If the validation convert option is on (enabled by default), the string will be forced to lowercase.\n */\n lowercase(): this;\n\n /**\n * Specifies the maximum number of string characters.\n * @param limit - the maximum number of string characters allowed. It can also be a reference to another field.\n * @param encoding - if specified, the string length is calculated in bytes using the provided encoding.\n */\n max(limit: number | Reference, encoding?: string): this;\n\n /**\n * Specifies the minimum number string characters.\n * @param limit - the minimum number of string characters required. It can also be a reference to another field.\n * @param encoding - if specified, the string length is calculated in bytes using the provided encoding.\n */\n min(limit: number | Reference, encoding?: string): this;\n\n /**\n * Requires the string value to be in a unicode normalized form. If the validation convert option is on (enabled by default), the string will be normalized.\n * @param [form='NFC'] - The unicode normalization form to use. Valid values: NFC [default], NFD, NFKC, NFKD\n */\n normalize(form?: \"NFC\" | \"NFD\" | \"NFKC\" | \"NFKD\"): this;\n\n /**\n * Defines a regular expression rule.\n * @param pattern - a regular expression object the string value must match against.\n * @param options - optional, can be:\n * Name for patterns (useful with multiple patterns). Defaults to 'required'.\n * An optional configuration object with the following supported properties:\n * name - optional pattern name.\n * invert - optional boolean flag. Defaults to false behavior. If specified as true, the provided pattern will be disallowed instead of required.\n */\n pattern(pattern: RegExp, options?: string | StringRegexOptions): this;\n\n /**\n * Defines a regular expression rule.\n * @param pattern - a regular expression object the string value must match against.\n * @param options - optional, can be:\n * Name for patterns (useful with multiple patterns). Defaults to 'required'.\n * An optional configuration object with the following supported properties:\n * name - optional pattern name.\n * invert - optional boolean flag. Defaults to false behavior. If specified as true, the provided pattern will be disallowed instead of required.\n */\n regex(pattern: RegExp, options?: string | StringRegexOptions): this;\n\n /**\n * Replace characters matching the given pattern with the specified replacement string where:\n * @param pattern - a regular expression object to match against, or a string of which all occurrences will be replaced.\n * @param replacement - the string that will replace the pattern.\n */\n replace(pattern: RegExp | string, replacement: string): this;\n\n /**\n * Requires the string value to only contain a-z, A-Z, 0-9, and underscore _.\n */\n token(): this;\n\n /**\n * Requires the string value to contain no whitespace before or after. If the validation convert option is on (enabled by default), the string will be trimmed.\n * @param [enabled=true] - optional parameter defaulting to true which allows you to reset the behavior of trim by providing a falsy value.\n */\n trim(enabled?: any): this;\n\n /**\n * Specifies whether the string.max() limit should be used as a truncation.\n * @param [enabled=true] - optional parameter defaulting to true which allows you to reset the behavior of truncate by providing a falsy value.\n */\n truncate(enabled?: boolean): this;\n\n /**\n * Requires the string value to be all uppercase. If the validation convert option is on (enabled by default), the string will be forced to uppercase.\n */\n uppercase(): this;\n\n /**\n * Requires the string value to be a valid RFC 3986 URI.\n */\n uri(options?: UriOptions): this;\n\n /**\n * Requires the string value to be a valid GUID.\n */\n uuid(options?: GuidOptions): this;\n }\n\n interface SymbolSchema extends AnySchema {\n // TODO: support number and symbol index\n map(\n iterable:\n | Iterable<[string | number | boolean | symbol, symbol]>\n | { [key: string]: symbol }\n ): this;\n }\n\n interface ArraySortOptions {\n /**\n * @default 'ascending'\n */\n order?: \"ascending\" | \"descending\";\n by?: string | Reference;\n }\n\n interface ArrayUniqueOptions extends HierarchySeparatorOptions {\n /**\n * if true, undefined values for the dot notation string comparator will not cause the array to fail on uniqueness.\n *\n * @default false\n */\n ignoreUndefined?: boolean;\n }\n\n type ComparatorFunction = (a: any, b: any) => boolean;\n\n type UnwrapSchemaLikeWithoutArray = T extends SchemaLikeWithoutArray<\n infer U\n >\n ? U\n : never;\n\n type NoNestedArrays = Extract<\n T[number],\n readonly unknown[]\n > extends never\n ? T\n : never;\n\n interface ArraySchema extends AnySchema {\n /**\n * Verifies that an assertion passes for at least one item in the array, where:\n * `schema` - the validation rules required to satisfy the assertion. If the `schema` includes references, they are resolved against\n * the array item being tested, not the value of the `ref` target.\n */\n has(schema: SchemaLike): this;\n\n /**\n * List the types allowed for the array values.\n * If a given type is .required() then there must be a matching item in the array.\n * If a type is .forbidden() then it cannot appear in the array.\n * Required items can be added multiple times to signify that multiple items must be found.\n * Errors will contain the number of items that didn't match.\n * Any unmatched item having a label will be mentioned explicitly.\n *\n * @param type - a joi schema object to validate each array item against.\n */\n items(a: SchemaLikeWithoutArray): ArraySchema;\n items(\n a: SchemaLikeWithoutArray,\n b: SchemaLikeWithoutArray\n ): ArraySchema<(A | B)[]>;\n items(\n a: SchemaLikeWithoutArray,\n b: SchemaLikeWithoutArray,\n c: SchemaLikeWithoutArray\n ): ArraySchema<(A | B | C)[]>;\n items(\n a: SchemaLikeWithoutArray,\n b: SchemaLikeWithoutArray,\n c: SchemaLikeWithoutArray,\n d: SchemaLikeWithoutArray\n ): ArraySchema<(A | B | C | D)[]>;\n items(\n a: SchemaLikeWithoutArray,\n b: SchemaLikeWithoutArray,\n c: SchemaLikeWithoutArray,\n d: SchemaLikeWithoutArray,\n e: SchemaLikeWithoutArray\n ): ArraySchema<(A | B | C | D | E)[]>;\n items(\n a: SchemaLikeWithoutArray,\n b: SchemaLikeWithoutArray,\n c: SchemaLikeWithoutArray,\n d: SchemaLikeWithoutArray,\n e: SchemaLikeWithoutArray,\n f: SchemaLikeWithoutArray\n ): ArraySchema<(A | B | C | D | E | F)[]>;\n items<\n TItems,\n TTItems extends SchemaLikeWithoutArray[] = SchemaLikeWithoutArray[]\n >(\n ...types: NoNestedArrays\n ): ArraySchema<\n {\n [I in keyof TTItems]: UnwrapSchemaLikeWithoutArray;\n }[number][]\n >;\n\n /**\n * Specifies the exact number of items in the array.\n */\n length(limit: number | Reference): this;\n\n /**\n * Specifies the maximum number of items in the array.\n */\n max(limit: number | Reference): this;\n\n /**\n * Specifies the minimum number of items in the array.\n */\n min(limit: number | Reference): this;\n\n /**\n * Lists the types in sequence order for the array values where:\n * @param type - a joi schema object to validate against each array item in sequence order. type can be multiple values passed as individual arguments.\n * If a given type is .required() then there must be a matching item with the same index position in the array.\n * Errors will contain the number of items that didn't match.\n * Any unmatched item having a label will be mentioned explicitly.\n */\n ordered(...types: SchemaLikeWithoutArray[]): this;\n\n /**\n * Allow single values to be checked against rules as if it were provided as an array.\n * enabled can be used with a falsy value to go back to the default behavior.\n */\n single(enabled?: any): this;\n\n /**\n * Sorts the array by given order.\n */\n sort(options?: ArraySortOptions): this;\n\n /**\n * Allow this array to be sparse.\n * enabled can be used with a falsy value to go back to the default behavior.\n */\n sparse(enabled?: any): this;\n\n /**\n * Requires the array values to be unique.\n * Remember that if you provide a custom comparator function,\n * different types can be passed as parameter depending on the rules you set on items.\n * Be aware that a deep equality is performed on elements of the array having a type of object,\n * a performance penalty is to be expected for this kind of operation.\n */\n unique(\n comparator?: string | ComparatorFunction,\n options?: ArrayUniqueOptions\n ): this;\n }\n\n interface ObjectPatternOptions {\n fallthrough?: boolean;\n matches: SchemaLike | Reference;\n }\n\n interface ObjectSchema extends AnySchema {\n /**\n * Defines an all-or-nothing relationship between keys where if one of the peers is present, all of them are required as well.\n *\n * Optional settings must be the last argument.\n */\n and(...peers: Array): this;\n\n /**\n * Appends the allowed object keys. If schema is null, undefined, or {}, no changes will be applied.\n */\n append(schema?: SchemaMap): this;\n append(\n schema?: SchemaMap\n ): ObjectSchema;\n\n /**\n * Verifies an assertion where.\n */\n assert(ref: string | Reference, schema: SchemaLike, message?: string): this;\n\n /**\n * Requires the object to be an instance of a given constructor.\n *\n * @param constructor - the constructor function that the object must be an instance of.\n * @param name - an alternate name to use in validation errors. This is useful when the constructor function does not have a name.\n */\n // tslint:disable-next-line:ban-types\n instance(constructor: Function, name?: string): this;\n\n /**\n * Sets or extends the allowed object keys.\n */\n keys(schema?: SchemaMap): this;\n\n /**\n * Specifies the exact number of keys in the object.\n */\n length(limit: number): this;\n\n /**\n * Specifies the maximum number of keys in the object.\n */\n max(limit: number | Reference): this;\n\n /**\n * Specifies the minimum number of keys in the object.\n */\n min(limit: number | Reference): this;\n\n /**\n * Defines a relationship between keys where not all peers can be present at the same time.\n *\n * Optional settings must be the last argument.\n */\n nand(...peers: Array): this;\n\n /**\n * Defines a relationship between keys where one of the peers is required (and more than one is allowed).\n *\n * Optional settings must be the last argument.\n */\n or(...peers: Array): this;\n\n /**\n * Defines an exclusive relationship between a set of keys where only one is allowed but none are required.\n *\n * Optional settings must be the last argument.\n */\n oxor(...peers: Array): this;\n\n /**\n * Specify validation rules for unknown keys matching a pattern.\n *\n * @param pattern - a pattern that can be either a regular expression or a joi schema that will be tested against the unknown key names\n * @param schema - the schema object matching keys must validate against\n */\n pattern(\n pattern: RegExp | SchemaLike,\n schema: SchemaLike,\n options?: ObjectPatternOptions\n ): this;\n\n /**\n * Requires the object to be a Joi reference.\n */\n ref(): this;\n\n /**\n * Requires the object to be a `RegExp` object.\n */\n regex(): this;\n\n /**\n * Renames a key to another name (deletes the renamed key).\n */\n rename(from: string | RegExp, to: string, options?: RenameOptions): this;\n\n /**\n * Requires the object to be a Joi schema instance.\n */\n schema(type?: SchemaLike): this;\n\n /**\n * Overrides the handling of unknown keys for the scope of the current object only (does not apply to children).\n */\n unknown(allow?: boolean): this;\n\n /**\n * Requires the presence of other keys whenever the specified key is present.\n */\n with(\n key: string,\n peers: string | string[],\n options?: DependencyOptions\n ): this;\n\n /**\n * Forbids the presence of other keys whenever the specified is present.\n */\n without(\n key: string,\n peers: string | string[],\n options?: DependencyOptions\n ): this;\n\n /**\n * Defines an exclusive relationship between a set of keys. one of them is required but not at the same time.\n *\n * Optional settings must be the last argument.\n */\n xor(...peers: Array): this;\n }\n\n interface BinarySchema extends AnySchema {\n /**\n * Sets the string encoding format if a string input is converted to a buffer.\n */\n encoding(encoding: string): this;\n\n /**\n * Specifies the minimum length of the buffer.\n */\n min(limit: number | Reference): this;\n\n /**\n * Specifies the maximum length of the buffer.\n */\n max(limit: number | Reference): this;\n\n /**\n * Specifies the exact length of the buffer:\n */\n length(limit: number | Reference): this;\n }\n\n interface DateSchema extends AnySchema {\n /**\n * Specifies that the value must be greater than date.\n * Notes: 'now' can be passed in lieu of date so as to always compare relatively to the current date,\n * allowing to explicitly ensure a date is either in the past or in the future.\n * It can also be a reference to another field.\n */\n greater(date: \"now\" | Date | number | string | Reference): this;\n\n /**\n * Requires the string value to be in valid ISO 8601 date format.\n */\n iso(): this;\n\n /**\n * Specifies that the value must be less than date.\n * Notes: 'now' can be passed in lieu of date so as to always compare relatively to the current date,\n * allowing to explicitly ensure a date is either in the past or in the future.\n * It can also be a reference to another field.\n */\n less(date: \"now\" | Date | number | string | Reference): this;\n\n /**\n * Specifies the oldest date allowed.\n * Notes: 'now' can be passed in lieu of date so as to always compare relatively to the current date,\n * allowing to explicitly ensure a date is either in the past or in the future.\n * It can also be a reference to another field.\n */\n min(date: \"now\" | Date | number | string | Reference): this;\n\n /**\n * Specifies the latest date allowed.\n * Notes: 'now' can be passed in lieu of date so as to always compare relatively to the current date,\n * allowing to explicitly ensure a date is either in the past or in the future.\n * It can also be a reference to another field.\n */\n max(date: \"now\" | Date | number | string | Reference): this;\n\n /**\n * Requires the value to be a timestamp interval from Unix Time.\n * @param type - the type of timestamp (allowed values are unix or javascript [default])\n */\n timestamp(type?: \"javascript\" | \"unix\"): this;\n }\n\n interface FunctionSchema extends ObjectSchema {\n /**\n * Specifies the arity of the function where:\n * @param n - the arity expected.\n */\n arity(n: number): this;\n\n /**\n * Requires the function to be a class.\n */\n class(): this;\n\n /**\n * Specifies the minimal arity of the function where:\n * @param n - the minimal arity expected.\n */\n minArity(n: number): this;\n\n /**\n * Specifies the minimal arity of the function where:\n * @param n - the minimal arity expected.\n */\n maxArity(n: number): this;\n }\n\n interface AlternativesSchema extends AnySchema {\n /**\n * Adds a conditional alternative schema type, either based on another key value, or a schema peeking into the current value.\n */\n conditional(\n ref: string | Reference,\n options: WhenOptions | WhenOptions[]\n ): AlternativesSchema;\n conditional(\n ref: Schema,\n options: WhenSchemaOptions\n ): AlternativesSchema;\n\n /**\n * Requires the validated value to match a specific set of the provided alternative.try() schemas.\n * Cannot be combined with `alternatives.conditional()`.\n */\n match(mode: \"any\" | \"all\" | \"one\"): this;\n\n /**\n * Adds an alternative schema type for attempting to match against the validated value.\n */\n try(a: SchemaLikeWithoutArray): AlternativesSchema;\n try(\n a: SchemaLikeWithoutArray,\n b: SchemaLikeWithoutArray\n ): AlternativesSchema;\n try(\n a: SchemaLikeWithoutArray,\n b: SchemaLikeWithoutArray,\n c: SchemaLikeWithoutArray\n ): AlternativesSchema;\n try(\n a: SchemaLikeWithoutArray,\n b: SchemaLikeWithoutArray,\n c: SchemaLikeWithoutArray,\n d: SchemaLikeWithoutArray\n ): AlternativesSchema;\n try(\n a: SchemaLikeWithoutArray,\n b: SchemaLikeWithoutArray,\n c: SchemaLikeWithoutArray,\n d: SchemaLikeWithoutArray,\n e: SchemaLikeWithoutArray\n ): AlternativesSchema;\n try(\n a: SchemaLikeWithoutArray,\n b: SchemaLikeWithoutArray,\n c: SchemaLikeWithoutArray,\n d: SchemaLikeWithoutArray,\n e: SchemaLikeWithoutArray,\n f: SchemaLikeWithoutArray\n ): AlternativesSchema;\n try(...types: SchemaLikeWithoutArray[]): this;\n }\n\n interface LinkSchema extends AnySchema {\n /**\n * Same as `any.concat()` but the schema is merged after the link is resolved which allows merging with schemas of the same type as the resolved link.\n * Will throw an exception during validation if the merged types are not compatible.\n */\n concat(schema: Schema): this;\n\n /**\n * Initializes the schema after constructions for cases where the schema has to be constructed first and then initialized.\n * If `ref` was not passed to the constructor, `link.ref()` must be called prior to usage.\n */\n ref(ref: string): this;\n }\n\n interface Reference extends Exclude {\n depth: number;\n type: string;\n key: string;\n root: string;\n path: string[];\n display: string;\n toString(): string;\n }\n\n type ExtensionBoundSchema = Schema & SchemaInternals;\n\n interface RuleArgs {\n name: string;\n ref?: boolean;\n assert?: ((value: any) => boolean) | AnySchema;\n message?: string;\n\n /**\n * Undocumented properties\n */\n normalize?(value: any): any;\n }\n\n type RuleMethod = (...args: any[]) => any;\n\n interface ExtensionRule {\n /**\n * alternative name for this rule.\n */\n alias?: string;\n /**\n * whether rule supports multiple invocations.\n */\n multi?: boolean;\n /**\n * Dual rule: converts or validates.\n */\n convert?: boolean;\n /**\n * list of arguments accepted by `method`.\n */\n args?: Array;\n /**\n * rule body.\n */\n method?: RuleMethod | false;\n /**\n * validation function.\n */\n validate?(\n value: any,\n helpers: any,\n args: Record,\n options: any\n ): any;\n\n /**\n * undocumented flags.\n */\n priority?: boolean;\n manifest?: boolean;\n }\n\n interface CoerceResult {\n errors?: ErrorReport[];\n value?: any;\n }\n\n type CoerceFunction = (value: any, helpers: CustomHelpers) => CoerceResult;\n\n interface CoerceObject {\n method: CoerceFunction;\n from?: string | string[];\n }\n\n interface ExtensionFlag {\n setter?: string;\n default?: any;\n }\n\n interface ExtensionTermManifest {\n mapped: {\n from: string;\n to: string;\n };\n }\n\n interface ExtensionTerm {\n init: any[] | null;\n register?: any;\n manifest?: Record;\n }\n\n interface Extension {\n type: string | RegExp;\n args?(...args: SchemaLike[]): Schema;\n base?: Schema;\n coerce?: CoerceFunction | CoerceObject;\n flags?: Record;\n manifest?: {\n build?(obj: ExtensionBoundSchema, desc: Record): any;\n };\n messages?: LanguageMessages | string;\n modifiers?: Record any>;\n overrides?: Record Schema>;\n prepare?(value: any, helpers: CustomHelpers): any;\n rebuild?(schema: ExtensionBoundSchema): void;\n rules?: Record>;\n terms?: Record;\n validate?(value: any, helpers: CustomHelpers): any;\n\n /**\n * undocumented options\n */\n cast?: Record<\n string,\n { from(value: any): any; to(value: any, helpers: CustomHelpers): any }\n >;\n properties?: Record;\n }\n\n type ExtensionFactory = (joi: Root) => Extension;\n\n interface Err {\n toString(): string;\n }\n\n // --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---\n\n interface Root {\n /**\n * Current version of the joi package.\n */\n version: string;\n\n ValidationError: new (\n message: string,\n details: ValidationErrorItem[],\n original: any\n ) => ValidationError;\n\n /**\n * Generates a schema object that matches any data type.\n */\n any(): AnySchema;\n\n /**\n * Generates a schema object that matches an array data type.\n */\n array(): ArraySchema;\n\n /**\n * Generates a schema object that matches a boolean data type (as well as the strings 'true' and 'false'). Can also be called via boolean().\n */\n bool(): BooleanSchema;\n\n /**\n * Generates a schema object that matches a boolean data type (as well as the strings 'true' and 'false'). Can also be called via bool().\n */\n boolean(): BooleanSchema;\n\n /**\n * Generates a schema object that matches a Buffer data type (as well as the strings which will be converted to Buffers).\n */\n binary(): BinarySchema;\n\n /**\n * Generates a schema object that matches a date type (as well as a JavaScript date string or number of milliseconds).\n */\n date(): DateSchema;\n\n /**\n * Generates a schema object that matches a function type.\n */\n func(): FunctionSchema;\n\n /**\n * Generates a schema object that matches a function type.\n */\n function(): FunctionSchema;\n\n /**\n * Generates a schema object that matches a number data type (as well as strings that can be converted to numbers).\n */\n number(): NumberSchema;\n\n /**\n * Generates a schema object that matches an object data type (as well as JSON strings that have been parsed into objects).\n */\n // tslint:disable-next-line:no-unnecessary-generics\n object(\n schema?: SchemaMap\n ): ObjectSchema;\n\n /**\n * Generates a schema object that matches a string data type. Note that empty strings are not allowed by default and must be enabled with allow('').\n */\n string(): StringSchema;\n\n /**\n * Generates a schema object that matches any symbol.\n */\n symbol(): SymbolSchema;\n\n /**\n * Generates a type that will match one of the provided alternative schemas\n */\n alternatives(\n params: [SchemaLike, SchemaLike]\n ): AlternativesSchema;\n alternatives(\n params: [SchemaLike, SchemaLike, SchemaLike]\n ): AlternativesSchema;\n alternatives(\n params: [SchemaLike, SchemaLike, SchemaLike, SchemaLike]\n ): AlternativesSchema;\n alternatives(\n params: [\n SchemaLike,\n SchemaLike,\n SchemaLike,\n SchemaLike,\n SchemaLike\n ]\n ): AlternativesSchema;\n alternatives(\n a: SchemaLike,\n b: SchemaLike\n ): AlternativesSchema;\n alternatives(\n a: SchemaLike,\n b: SchemaLike,\n c: SchemaLike\n ): AlternativesSchema;\n alternatives(\n a: SchemaLike,\n b: SchemaLike