@ovotech/json-schema | Laminar

Type aliases

CoerceOptions

CoerceOptions: CoerceSchemaOptions | CoerceCompiledOptions

Coercer

Coercer<TSchema, TValue>: (schema: TSchema, value: TValue, options: CoercerOptions) => TValue

Type parameters

TSchema = JsonSchema
TValue = unknown

Type declaration

- (schema: TSchema, value: TValue, options: CoercerOptions): TValue
- Parameters
  - schema: TSchema
  - value: TValue
  - options: CoercerOptions
  Returns TValue

FormatErrors

FormatErrors: ((errors: Validation) => string[]) | boolean

InvalidCode

Messages

Messages: Record<InvalidCode, (error: Invalid) => string>

PrimitiveType

Result

Result<T>: ResultSuccess<T> | ResultError

Type parameters

Schema

Schema: JsonSchema | boolean

ValidateOptions

ValidateOptions: ValidateSchemaOptions | ValidateCompiledOptions

Validator

Validator<TSchema, TValue>: (schema: TSchema, value: TValue, options: Options) => Validation

Type parameters

TSchema = JsonSchema
TValue = unknown

Type declaration

- (schema: TSchema, value: TValue, options: Options): Validation
- Parameters
  - schema: TSchema
  - value: TValue
  - options: Options
  Returns Validation

Variables

coercers

coercers: { json: Coercer<JsonSchema, unknown>[]; query: Coercer<JsonSchema, unknown>[] } = ...

Type declaration

json: Coercer<JsonSchema, unknown>[]
query: Coercer<JsonSchema, unknown>[]

empty

empty: Validation = ...

messages

messages: Messages = ...

Functions

Const childOptions

childOptions(name: string | number, options: Options): Options

- Defined in packages/json-schema/src/validation.ts:122
Parameters
- name: string | number
- options: Options
Returns Options

coerce

coerce(options: CoerceCompiledOptions): unknown
coerce(options: CoerceSchemaOptions): Promise<unknown>

- Defined in packages/json-schema/src/coerce.ts:46
Coerce a given value, using the provided json schema.
- With type: 'json' This is used to convert json validated with json schema into javascript objects. Namely it converts all the strings with format date and date-time into Date objects
- With type: 'query' To convert a value coming from a URL query string to the type you want it to be, for example '12' with type: 'integer' will be converted to 12 so the validation can succeed.
Additionally, we assign default values where appropriate.
Parameters
- options: CoerceCompiledOptions
Returns unknown
- Defined in packages/json-schema/src/coerce.ts:47
Parameters
- options: CoerceSchemaOptions
Returns Promise<unknown>

coerceCompiled

coerceCompiled(__namedParameters: CoerceCompiledOptions): unknown

- Defined in packages/json-schema/src/coerce.ts:23
Parameters
- __namedParameters: CoerceCompiledOptions
Returns unknown

Const coerceSchema

coerceSchema(schema: Schema, value: unknown, options: CoercerOptions): unknown

- Defined in packages/json-schema/src/coercion.ts:23
Parameters
- schema: Schema
- value: unknown
- options: CoercerOptions
Returns unknown

Const combine

combine(validations: Validation[]): Validation

- Defined in packages/json-schema/src/validation.ts:102
Parameters
- validations: Validation[]
Returns Validation

Const combineErrors

combineErrors(validations: Validation[]): Validation

- Defined in packages/json-schema/src/validation.ts:113
Parameters
- validations: Validation[]
Returns Validation

Const compile

compile(schema: string | Schema): Promise<ResolvedSchema<Schema>>

- Defined in packages/json-schema/src/resolve.ts:264
Parameters
- schema: string | Schema
Returns Promise<ResolvedSchema<Schema>>

ensureValid

ensureValid<T>(options: ValidateSchemaOptions): Promise<ResultSuccess<T>>
ensureValid<T>(options: ValidateCompiledOptions): ResultSuccess<T>

- Defined in packages/json-schema/src/validate.ts:98
Type parameters
- T
Parameters
- options: ValidateSchemaOptions
Returns Promise<ResultSuccess<T>>
- Defined in packages/json-schema/src/validate.ts:99
Type parameters
- T
Parameters
- options: ValidateCompiledOptions
Returns ResultSuccess<T>

ensureValidCompiled

ensureValidCompiled<T>(options: ValidateCompiledOptions): ResultSuccess<T>

- Defined in packages/json-schema/src/validate.ts:90
Type parameters
- T
Parameters
- options: ValidateCompiledOptions
Returns ResultSuccess<T>

Const error

error(code: InvalidCode, name: string, param?: unknown): Validation

- Defined in packages/json-schema/src/validation.ts:69
Parameters
- code: InvalidCode
- name: string
- Optional param: unknown
Returns Validation

Const errors

errors(__namedParameters: Validation): Invalid<unknown>[]

- Defined in packages/json-schema/src/validation.ts:77
Parameters
- __namedParameters: Validation
Returns Invalid<unknown>[]

Const evaluateItem

evaluateItem(item: number, validation: Validation): Validation

- Defined in packages/json-schema/src/validation.ts:79
Parameters
- item: number
- validation: Validation
Returns Validation

Const evaluateProperty

evaluateProperty(property: string, validation: Validation): Validation

- Defined in packages/json-schema/src/validation.ts:84
Parameters
- property: string
- validation: Validation
Returns Validation

Const hasErrors

hasErrors(__namedParameters: Validation): boolean

- Defined in packages/json-schema/src/validation.ts:91
Parameters
- __namedParameters: Validation
Returns boolean

Const hasEvaluatedItem

hasEvaluatedItem(item: number, __namedParameters: Options | Validation): boolean

- Defined in packages/json-schema/src/validation.ts:93
Parameters
- item: number
- __namedParameters: Options | Validation
Returns boolean

Const hasEvaluatedProperty

hasEvaluatedProperty(property: string, __namedParameters: Options | Validation): boolean

- Defined in packages/json-schema/src/validation.ts:96
Parameters
- property: string
- __namedParameters: Options | Validation
Returns boolean

Const isCompiled

isCompiled(schema: string | Schema | ResolvedSchema<Schema>): schema is ResolvedSchema<Schema>

- Defined in packages/json-schema/src/resolve.ts:277
Parameters
- schema: string | Schema | ResolvedSchema<Schema>
Returns schema is ResolvedSchema<Schema>

Const onlyErrors

onlyErrors(__namedParameters: Validation): Validation

- Defined in packages/json-schema/src/validation.ts:75
Parameters
- __namedParameters: Validation
Returns Validation

Const resolve

resolve(original: Schema, fileContext?: FileContext): Promise<ResolvedSchema<Schema>>

- Defined in packages/json-schema/src/resolve.ts:250
Parameters
- original: Schema
- fileContext: FileContext = {}
Returns Promise<ResolvedSchema<Schema>>

Const resolveFile

resolveFile(file: string): Promise<ResolvedSchema<Schema>>

- Defined in packages/json-schema/src/resolve.ts:258
Parameters
- file: string
Returns Promise<ResolvedSchema<Schema>>

Const skipRest

skipRest(validation: Validation): Validation

- Defined in packages/json-schema/src/validation.ts:89
Parameters
- validation: Validation
Returns Validation

Const toMessage

toMessage(messages: Messages): (error: Invalid<unknown>) => string

- Defined in packages/json-schema/src/messages.ts:63
Parameters
- messages: Messages
Returns (error: Invalid<unknown>) => string
- - (error: Invalid<unknown>): string
  - Parameters
    - error: Invalid<unknown>
    Returns string

Const toMessages

toMessages(messages: Messages): (validation: Validation) => string[]

- Defined in packages/json-schema/src/messages.ts:68
Parameters
- messages: Messages
Returns (validation: Validation) => string[]
- - (validation: Validation): string[]
  - Parameters
    - validation: Validation
    Returns string[]

Const toSchemaObject

toSchemaObject<T>(schema: ResolvedSchema<T>): T

- Defined in packages/json-schema/src/resolve.ts:267
Type parameters
- T: Schema = Schema
Parameters
- schema: ResolvedSchema<T>
Returns T

validate

validate<T>(options: ValidateSchemaOptions): Promise<Result<T>>
validate<T>(options: ValidateCompiledOptions): Result<T>

- Defined in packages/json-schema/src/validate.ts:82
Type parameters
- T
Parameters
- options: ValidateSchemaOptions
Returns Promise<Result<T>>
- Defined in packages/json-schema/src/validate.ts:83
Type parameters
- T
Parameters
- options: ValidateCompiledOptions
Returns Result<T>

validateCompiled

validateCompiled<T>(__namedParameters: ValidateCompiledOptions): Result<T>

- Defined in packages/json-schema/src/validate.ts:66
Type parameters
- T
Parameters
- __namedParameters: ValidateCompiledOptions
Returns Result<T>

Const validateSchema

validateSchema(schema: Schema, value: unknown, options: Options): Validation

- Defined in packages/json-schema/src/validation.ts:127
Parameters
- schema: Schema
- value: unknown
- options: Options
Returns Validation

Const withinContext

withinContext<T>(schema: T, contextSchema: ResolvedSchema<Schema>): ResolvedSchema<T>

- Defined in packages/json-schema/src/resolve.ts:272
Get a schema within the context of refs and uris of another compiled schema

Type parameters
- T: Schema = Schema
Parameters
- schema: T
- contextSchema: ResolvedSchema<Schema>
Returns ResolvedSchema<T>

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

CoerceOptions

Coercer

Type parameters

TSchema = JsonSchema

TValue = unknown

Type declaration

Parameters

schema: TSchema

value: TValue

options: CoercerOptions

Returns TValue

FormatErrors

InvalidCode

Messages

PrimitiveType

Result

Type parameters

T

Schema

ValidateOptions

Validator

Type parameters

TSchema = JsonSchema

TValue = unknown

Type declaration

Parameters

schema: TSchema

value: TValue

options: Options

Returns Validation

Variables

coercers

Type declaration

json: Coercer<JsonSchema, unknown>[]

query: Coercer<JsonSchema, unknown>[]

empty

messages

Functions

Const childOptions

Parameters

name: string | number

options: Options

Returns Options

coerce

Parameters

options: CoerceCompiledOptions

Returns unknown

Parameters

options: CoerceSchemaOptions

Returns Promise<unknown>

coerceCompiled

Parameters

__namedParameters: CoerceCompiledOptions

Returns unknown

Const coerceSchema

Parameters

schema: Schema

value: unknown

options: CoercerOptions

Returns unknown

Const combine

Parameters

validations: Validation[]

Returns Validation

Const combineErrors

Parameters

validations: Validation[]

Returns Validation

Const compile

Parameters

schema: string | Schema

Returns Promise<ResolvedSchema<Schema>>

ensureValid