Class ValidationService

Hierarchy

ValidationService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ValidationService(store: default, schema?: JSONSchema, core?: any): ValidationService

- Defined in src/services/ValidationService.ts:34
Parameters
- store: default
- schema: JSONSchema = ...
- core: any = ...
Returns ValidationService

Properties

core

core: any

currentValidation

currentValidation: default

errorHandler

errorHandler: ValidationErrorMapper

observer

observer: BubblingCollectionObservable = ...

schema

schema: JSONSchema

store

store: default

watcher

watcher: any[] = ...

list of active watchers on update-lifecycle events

Methods

destroy

destroy(): void

- Defined in src/services/ValidationService.ts:158
Returns void

get

get(): JSONSchema

- Defined in src/services/ValidationService.ts:102
returns the current json-schema

Returns JSONSchema

getErrors

getErrors(pointer?: string, withChildErrors?: boolean): ValidationError[]

- Defined in src/services/ValidationService.ts:149
returns all validation errors only

Parameters
- Optional pointer: string
- withChildErrors: boolean = false
Returns ValidationError[]

getErrorsAndWarnings

getErrorsAndWarnings(pointer?: string, withChildErrors?: boolean): ValidationError[]

- Defined in src/services/ValidationService.ts:138
returns all validation errors and warnings

Parameters
- Optional pointer: string
- withChildErrors: boolean = false
Returns ValidationError[]

getWarnings

getWarnings(pointer?: string, withChildWarnings?: boolean): ValidationError[]

- Defined in src/services/ValidationService.ts:154
returns all validation warnings only

Parameters
- Optional pointer: string
- withChildWarnings: boolean = false
Returns ValidationError[]

notify

notify(pointer: string, event: ValidationError): void

- Defined in src/services/ValidationService.ts:116
Parameters
- pointer: string
- event: ValidationError
Returns void

notifyWatcher

notifyWatcher(event: ValidationDoneEvent): void

- Defined in src/services/ValidationService.ts:120
Parameters
- event: ValidationDoneEvent
Returns void

observe

observe(pointer: string, observer: Observer, bubbledEvents?: boolean): Observer

- Defined in src/services/ValidationService.ts:106
Parameters
- pointer: string
- observer: Observer
- bubbledEvents: boolean = false
Returns Observer

removeObserver

removeObserver(pointer: string, observer: Observer): ValidationService

- Defined in src/services/ValidationService.ts:111
Parameters
- pointer: string
- observer: Observer
Returns ValidationService

set

set(schema: JSONSchema): void

- Defined in src/services/ValidationService.ts:96
set or change the json-schema for data validation

Parameters
- schema: JSONSchema
Returns void

setErrorHandler

setErrorHandler(callback: ValidationErrorMapper): void

- Defined in src/services/ValidationService.ts:48
sets a custom error handler to map errors

Parameters
- callback: ValidationErrorMapper
Returns void

unwatch

unwatch(callback: Watcher): Watcher

- Defined in src/services/ValidationService.ts:132
Parameters
- callback: Watcher
Returns Watcher

validate

validate(data: any, pointer?: string): Promise<ValidationError[]>

- Defined in src/services/ValidationService.ts:58
Starts the validation, executing callback handlers and emitters on the go

Parameters
- data: any
  
  data to validate
- pointer: string = "#"
Returns Promise<ValidationError[]>

promise, resolving with list of errors when all async validations are performed

watch

watch(callback: Watcher): Watcher

- Defined in src/services/ValidationService.ts:125
watch DataService lifecycle events

Parameters
- callback: Watcher
Returns Watcher

Generated using TypeDoc