AllOfSchema | json-schema-to-joi

Hierarchy

AnySchema
- AllOfSchema

Index

Properties

Methods

Properties

isJoi

isJoi: boolean

Optional schemaType

schemaType: Types | string

Methods

allow

allow(values: any[]): this
allow(values: any[]): this

Inherited from AnySchema.allow
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:282
Parameters
- Rest values: any[]
Returns this
Inherited from AnySchema.allow
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:283
Parameters
- values: any[]
Returns this

bind

bind(): this

Inherited from AnySchema.bind
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:291
Returns this

concat

concat(schema: this): this

Inherited from AnySchema.concat
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:397
Parameters
- schema: this
Returns this

default

default(value: any, description: undefined | string): this

Inherited from AnySchema.default
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:392
Parameters
- Optional value: any
- Optional description: undefined | string
Returns this

describe

describe(): Description

Inherited from AnySchema.describe
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:444
Returns Description

description

description(desc: string): this

Inherited from AnySchema.description
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:337
Parameters
- desc: string
Returns this

disallow

disallow(values: any[]): this
disallow(values: any[]): this

Inherited from AnySchema.disallow
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:308
Parameters
- Rest values: any[]
Returns this
Inherited from AnySchema.disallow
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:309
Parameters
- values: any[]
Returns this

empty

empty(schema: SchemaLike): this

Inherited from AnySchema.empty
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:419
Parameters
- Optional schema: SchemaLike
Returns this

equal

equal(values: any[]): this
equal(values: any[]): this

Inherited from AnySchema.equal
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:300
Parameters
- Rest values: any[]
Returns this
Inherited from AnySchema.equal
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:301
Parameters
- values: any[]
Returns this

error

error(err: Error | ValidationErrorFunction, options: ErrorOptions): this

Inherited from AnySchema.error
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:439
Parameters
- err: Error | ValidationErrorFunction
- Optional options: ErrorOptions
Returns this

example

example(value: any): this

Inherited from AnySchema.example
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:357
Parameters
- value: any
Returns this

exist

exist(): this

Inherited from AnySchema.exist
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:317
Returns this

forbidden

forbidden(): this

Inherited from AnySchema.forbidden
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:327
Returns this

invalid

invalid(values: any[]): this
invalid(values: any[]): this

Inherited from AnySchema.invalid
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:306
Parameters
- Rest values: any[]
Returns this
Inherited from AnySchema.invalid
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:307
Parameters
- values: any[]
Returns this

items

items(types: Joi.SchemaLike[]): this

- Defined in extendedJoi/allOf.ts:4
Parameters
- types: Joi.SchemaLike[]
Returns this

label

label(name: string): this

Inherited from AnySchema.label
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:408
Parameters
- name: string
Returns this

not

not(values: any[]): this
not(values: any[]): this

Inherited from AnySchema.not
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:310
Parameters
- Rest values: any[]
Returns this
Inherited from AnySchema.not
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:311
Parameters
- values: any[]
Returns this

notes

notes(notes: string | string[]): this

Inherited from AnySchema.notes
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:342
Parameters
- notes: string | string[]
Returns this

only

only(values: any[]): this
only(values: any[]): this

Inherited from AnySchema.only
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:298
Parameters
- Rest values: any[]
Returns this
Inherited from AnySchema.only
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:299
Parameters
- values: any[]
Returns this

optional

optional(): this

Inherited from AnySchema.optional
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:322
Returns this

options

options(options: ValidationOptions): this

Inherited from AnySchema.options
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:367
Parameters
- options: ValidationOptions
Returns this

raw

raw(isRaw: undefined | false | true): this

Inherited from AnySchema.raw
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:413
Parameters
- Optional isRaw: undefined | false | true
Returns this

required

required(): this

Inherited from AnySchema.required
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:316
Returns this

strict

strict(isStrict: undefined | false | true): this

Inherited from AnySchema.strict
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:372
Parameters
- Optional isStrict: undefined | false | true
Returns this

strip

strip(): this

Inherited from AnySchema.strip
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:332
Returns this

unit

unit(name: string): this

Inherited from AnySchema.unit
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:362
Parameters
- name: string
Returns this

valid

valid(values: any[]): this
valid(values: any[]): this

Inherited from AnySchema.valid
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:296
Parameters
- Rest values: any[]
Returns this
Inherited from AnySchema.valid
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:297
Parameters
- values: any[]
Returns this

validate

validate<T>(value: T, options: ValidationOptions): ValidationResult<T>
validate<T, R>(value: T, callback: function): R
validate<T, R>(value: T, options: ValidationOptions, callback: function): R

Inherited from AnySchema.validate
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:275
Type parameters
- T
Parameters
- value: T
- Optional options: ValidationOptions
Returns ValidationResult<T>
Inherited from AnySchema.validate
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:276
Type parameters
- T
- R
Parameters
- value: T
- callback: function
  - - (err: ValidationError, value: T): R
    - Parameters
      - err: ValidationError
      - value: T
      Returns R
Returns R
Inherited from AnySchema.validate
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:277
Type parameters
- T
- R
Parameters
- value: T
- options: ValidationOptions
- callback: function
  - - (err: ValidationError, value: T): R
    - Parameters
      - err: ValidationError
      - value: T
      Returns R
Returns R

when

when(ref: string | Reference, options: WhenOptions): AlternativesSchema
when(ref: Schema, options: WhenSchemaOptions): AlternativesSchema

Inherited from AnySchema.when
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:402
Parameters
- ref: string | Reference
- options: WhenOptions
Returns AlternativesSchema
Inherited from AnySchema.when
- Defined in /mnt/c/Users/emmayyg/OpenSources/f5f6/json-schema-to-joi/node_modules/@types/joi/index.d.ts:403
Parameters
- ref: Schema
- options: WhenSchemaOptions
Returns AlternativesSchema

Hierarchy

Index

Properties

Methods

Properties

isJoi

Optional schemaType

Methods

allow

Parameters

Rest values: any[]

Returns this

Parameters

values: any[]

Returns this

bind

Returns this

concat

Parameters

schema: this

Returns this

default

Parameters

Optional value: any

Optional description: undefined | string

Returns this

describe

Returns Description

description

Parameters

desc: string

Returns this

disallow

Parameters

Rest values: any[]

Returns this

Parameters

values: any[]

Returns this

empty

Parameters

Optional schema: SchemaLike

Returns this

equal

Parameters

Rest values: any[]

Returns this

Parameters

values: any[]

Returns this

error

Parameters

err: Error | ValidationErrorFunction

Optional options: ErrorOptions

Returns this

example

Parameters

value: any

Returns this

exist

Returns this

forbidden

Returns this

invalid

Parameters

Rest values: any[]

Returns this

Parameters

values: any[]

Returns this

items

Parameters

types: Joi.SchemaLike[]

Returns this

label

Parameters

name: string

Returns this

meta

Parameters