Function

Static Public Summary
public	HTTP(method: String, path: String, contentType: String): function(meta: DecoratorDescriptor): void Hookable decorator for RESTful API
public	HTTP_URL(value: *, key: String, data: Model)
public	IPA(value: *, key: String, data: Model) Validator for IP address
public	IPv4(value: *, key: String, data: Model)
public	IPv6(value: *, key: String, data: Model)
public	Range(min: Number, max: Number, step: Number): ModelValueHandler
public	is(condition: Function \| RegExp \| Array \| ModelValueHandler, defaultValue: *): function(meta: DecoratorDescriptor): void Field Decorator to validate the value of Setter
public	isClass(func: Function): Boolean
public	listen(name: String, handler: function(data: Object): void) Hook listener
public	mapGetter(meta: DecoratorDescriptor) Class Decorator to set same name Getters of existed Setters
public	trigger(name: String, data: Object) Hook trigger
public	typeOf(object: *): String
public	* walkPrototype(object: *)

Static Public

public HTTP(method: String, path: String, contentType: String): function(meta: DecoratorDescriptor): void source

import {HTTP} from 'data-scheme/source/hook/index.js'

Hookable decorator for RESTful API

Params:

Name	Type	Attribute	Description
method	String
path	String
contentType	String	optional default: 'application/json'

Return:

function(meta: DecoratorDescriptor): void

Test:

Scheme class Decorator Hook

public HTTP_URL(value: *, key: String, data: Model) source

import {HTTP_URL} from 'data-scheme/source/scheme/index.js'

Params:

Name	Type	Attribute	Description
value	*
key	String
data	Model

Test:

Scheme validator HTTP URL

public IPA(value: *, key: String, data: Model) source

import {IPA} from 'data-scheme/source/scheme/index.js'

Validator for IP address

Params:

Name	Type	Attribute	Description
value	*
key	String
data	Model

public IPv4(value: *, key: String, data: Model) source

import {IPv4} from 'data-scheme/source/scheme/index.js'

Params:

Name	Type	Attribute	Description
value	*
key	String
data	Model

Test:

Scheme validator IP v4

public IPv6(value: *, key: String, data: Model) source

import {IPv6} from 'data-scheme/source/scheme/index.js'

Params:

Name	Type	Attribute	Description
value	*
key	String
data	Model

Test:

Scheme validator IP v6

public Range(min: Number, max: Number, step: Number): ModelValueHandler source

import {Range} from 'data-scheme/source/scheme/index.js'

Params:

Name	Type	Attribute	Description
min	Number	optional default: -Infinity
max	Number	optional default: +Infinity
step	Number	optional default: 1

Return:

ModelValueHandler

Test:

Scheme class Number range

public is(condition: Function | RegExp | Array | ModelValueHandler, defaultValue: *): function(meta: DecoratorDescriptor): void source

import {is} from 'data-scheme/source/validator.js'

Field Decorator to validate the value of Setter

Params:

Name	Type	Attribute	Description
condition	Function \| RegExp \| Array \| ModelValueHandler
defaultValue	*	optional

Return:

function(meta: DecoratorDescriptor): void

Test:

public isClass(func: Function): Boolean source

import {isClass} from 'data-scheme/source/utility/index.js'

Params:

Name	Type	Attribute	Description
func	Function

Return:

Boolean

public listen(name: String, handler: function(data: Object): void) source

import {listen} from 'data-scheme/source/hook/index.js'

Hook listener

Params:

Name	Type	Attribute	Description
name	String
handler	function(data: Object): void

Test:

Scheme class Decorator Hook

public mapGetter(meta: DecoratorDescriptor) source

import {mapGetter} from 'data-scheme/source/Model.js'

Class Decorator to set same name Getters of existed Setters

Params:

Name	Type	Attribute	Description
meta	DecoratorDescriptor

Test:

Scheme class Getter / Setter pairs

public trigger(name: String, data: Object) source

import {trigger} from 'data-scheme/source/hook/index.js'

Hook trigger

Params:

Name	Type	Attribute	Description
name	String
data	Object

Test:

Scheme class Decorator Hook

public typeOf(object: *): String source

import {typeOf} from 'data-scheme/source/utility/index.js'

Params:

Name	Type	Attribute	Description
object	*

Return:

String

Class name

public * walkPrototype(object: *) source

import {walkPrototype} from 'data-scheme/source/utility/index.js'

Params:

Name	Type	Attribute	Description
object	*