import {Model} from 'datamatic/src/Model/index.js'

public class | source

Model

RxVo Model Entry-point

Static Method Summary

Static Public Methods
public static	fromJSON(json: string \| json, options: object): Model Creates new PropertiesModel from JSON data

Constructor Summary

Public Constructor
public	constructor(schemas: json, options: object)

Member Summary

Public Members
public get	errors: error[] \| null: * Getter for Ajv validation error messages
public get	isFrozen: boolean: * Returns true if object is frozen
public get	model: object \| array: * Getter for root Model
public set	model(value: object \| array) Setter for root Model value
public get	schema: any: * Getter for document's JSON-Schema

Method Summary

Public Methods
public	addSchema(schema: *): boolean Adds Schema to Validator instance
public	freeze(): Model Freezes document object
public	getModelsInPath(to: *): Array[] \| Object[] Retrieves all Models at given path
public	getPath(to: *): Object \| Array
public	getSchemaForKey(id: ): returns schema with given id
public	getSchemaForPath(path: *): any Retrieves JSON-Schema element for given Path
public	pipeline(pipesOrSchemas: *): Pipe
public	subscribe(observer: *): Observable Subscribes observer to root Model
public	subscribeTo(path: , observer: ): Observable Subscribes observer to Model at path
public	toJSON(): * Implements toJSON
public	toString(): string Implements toString
public	useSchema(id: *) Selects schema to validate against (advanced option, use wisely)
public	validate(path: , value: ): * \| void \| RegExpExecArray Validates data against named schema

Static Public Methods

public static fromJSON(json: string | json, options: object): Model source

Creates new PropertiesModel from JSON data

Params:

Name	Type	Attribute	Description
json	string \| json		JSON Object or String
options	object		Model options object

Return:

Model

Public Constructors

public constructor(schemas: json, options: object) source

Params:

Name	Type	Attribute	Description
schemas	json
options	object

Public Members

public get errors: error[] | null: * source

Getter for Ajv validation error messages

Return:

error[] | null

public get isFrozen: boolean: * source

Returns true if object is frozen

Return:

boolean

public get model: object | array: * source

Getter for root Model

Return:

object | array

public set model(value: object | array) source

Setter for root Model value

public get schema: any: * source

Getter for document's JSON-Schema

Return:

any

Public Methods

public addSchema(schema: *): boolean source

Adds Schema to Validator instance

Params:

Name	Type	Attribute	Description
schema	*

Return:

boolean

public freeze(): Model source

Freezes document object

Return:

Model

public getModelsInPath(to: *): Array[] | Object[] source

Retrieves all Models at given path

Params:

Name	Type	Attribute	Description
to	*

Return:

Array[] | Object[]

public getPath(to: *): Object | Array source

Params:

Name	Type	Attribute	Description
to	*

Return:

Object | Array

public getSchemaForKey(id: ): source

returns schema with given id

Params:

Name	Type	Attribute	Description
id	*

Return:

public getSchemaForPath(path: *): any source

Retrieves JSON-Schema element for given Path

Params:

Name	Type	Attribute	Description
path	*

Return:

any

public pipeline(pipesOrSchemas: *): Pipe source

Params:

Name	Type	Attribute	Description
pipesOrSchemas	*

Return:

Pipe

Subscribes observer to root Model

Params:

Name	Type	Attribute	Description
observer	*

Return:

Observable

public subscribeTo(path: , observer: ): Observable source

Subscribes observer to Model at path

Params:

Name	Type	Attribute	Description
path	*
observer	*

Return:

Observable

public toJSON(): * source

Implements toJSON

Return:

public toString(): string source

Implements toString

Return:

string

public useSchema(id: *) source

Selects schema to validate against (advanced option, use wisely)

Params:

Name	Type	Attribute	Description
id	*

public validate(path: , value: ): * | void | RegExpExecArray source

Validates data against named schema

Params:

Name	Type	Attribute	Description
path	*
value	*

Return:

* | void | RegExpExecArray

Model

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Static Public Methods

public static fromJSON(json: string | json, options: object): Model source

Params:

Return:

Public Constructors

public constructor(schemas: json, options: object) source

Params:

Public Members

public get errors: error[] | null: * source

Return:

public get isFrozen: boolean: * source

Return:

public get model: object | array: * source

Return:

public set model(value: object | array) source

public get schema: any: * source

Return:

Public Methods

public addSchema(schema: *): boolean source

Params:

Return:

public freeze(): Model source

Return:

public getModelsInPath(to: *): Array[] | Object[] source

Params:

Return:

public getPath(to: *): Object | Array source

Params:

Return:

public getSchemaForKey(id: *): * source

Params:

Return:

public getSchemaForPath(path: *): any source

Params:

Return:

public pipeline(pipesOrSchemas: *): Pipe source

Params:

Return:

public subscribe(observer: *): Observable source

Params:

Return:

public subscribeTo(path: *, observer: *): Observable source

Params:

Return:

public toJSON(): * source

Return:

public toString(): string source

Return:

public useSchema(id: *) source

Params:

public validate(path: *, value: *): * | void | RegExpExecArray source

Params:

Return:

public getSchemaForKey(id: ): source

public subscribeTo(path: , observer: ): Observable source

public validate(path: , value: ): * | void | RegExpExecArray source