@itryapitsin/ts-decorators

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Constructor

Constructor: object

Constructor for class type

Type declaration

Mixin

Mixin: Constructor<T> | object

Type of class mixin

Variables

Const INFO_COLOR

INFO_COLOR: "#208BDA" = "#208BDA"

Information message color in console

Const WARNING_COLOR

WARNING_COLOR: "#DA940B" = "#DA940B"

Warning message color in console

Const jsonMetadataKey

jsonMetadataKey: "json-property" = "json-property"

Const maxLengthMetadataKey

maxLengthMetadataKey: unique symbol = Symbol('max-length')

Const minLengthMetadataKey

minLengthMetadataKey: unique symbol = Symbol('min-length')

Const regexMetadataKey

regexMetadataKey: unique symbol = Symbol('regex')

Const requiredMetadataKey

requiredMetadataKey: unique symbol = Symbol('required')

Const rulePool

rulePool: RuleFunction[] = [validateNulls,validateMaxLength,validateMinLength,validateRegex,]

Container of rules

Functions

IsArray

IsArray(object: any): boolean

- Defined in types.ts:118
Parameters
- object: any
Returns boolean

IsBoolean

IsBoolean(x: any): boolean

- Defined in types.ts:77
Test an object for boolean

6.1.7 The Object Type https://tc39.github.io/ecma262/#sec-object-type

Parameters
- x: any
  
  tested instance
Returns boolean

IsFunction

IsFunction(x: any): boolean

- Defined in types.ts:55
Test an object for object and not null

6.1.7 The Object Type https://tc39.github.io/ecma262/#sec-object-type

Parameters
- x: any
  
  tested instance
Returns boolean

IsNotNullAndUndefined

IsNotNullAndUndefined(x: any): boolean

- Defined in types.ts:99
Test an object for not null and not undefined

6.1.7 The Object Type https://tc39.github.io/ecma262/#sec-object-type

Parameters
- x: any
  
  tested instance
Returns boolean

IsNull

IsNull(x: any): boolean

- Defined in types.ts:23
Test an object for null

6.1.2 The Null Type https://tc39.github.io/ecma262/#sec-ecmascript-language-types-null-type

Parameters
- x: any
  
  tested instance
Returns boolean

IsNullOrUndefined

IsNullOrUndefined(x: any): boolean

- Defined in types.ts:110
Test an object for null or undefined

6.1.7 The Object Type https://tc39.github.io/ecma262/#sec-object-type

Parameters
- x: any
  
  tested instance
Returns boolean

IsNumber

IsNumber(x: any): boolean

- Defined in types.ts:88
Test an object for number

6.1.7 The Object Type https://tc39.github.io/ecma262/#sec-object-type

Parameters
- x: any
  
  tested instance
Returns boolean

IsObject

IsObject(x: any): boolean

- Defined in types.ts:44
Test an object for object and not null

6.1.7 The Object Type https://tc39.github.io/ecma262/#sec-object-type

Parameters
- x: any
  
  tested instance
Returns boolean

IsPrimitive

IsPrimitive(x: any): boolean

- Defined in types.ts:114
Parameters
- x: any
Returns boolean

IsString

IsString(x: any): boolean

- Defined in types.ts:66
Test an object for object and not null

6.1.7 The Object Type https://tc39.github.io/ecma262/#sec-object-type

Parameters
- x: any
  
  tested instance
Returns boolean

IsSymbol

IsSymbol(x: any): boolean

- Defined in types.ts:33
Test an object for Symbol 6.1.5 The Symbol Type https://tc39.github.io/ecma262/#sec-ecmascript-language-types-symbol-type

Parameters
- x: any
  
  tested instance
Returns boolean

IsUndefined

IsUndefined(x: any): boolean

- Defined in types.ts:12
Test an object for undefined

6.1.1 The Undefined Type https://tc39.github.io/ecma262/#sec-ecmascript-language-types-undefined-type

Parameters
- x: any
  
  tested instance
Returns boolean

cached

cached(): (Anonymous function)

- Defined in method-decorators/cached.ts:9
Cache method call by params

Returns (Anonymous function)

customValidator

customValidator<T>(name: string, data?: T): ParameterDecorator

- Defined in method-decorators/validator.ts:114
Type parameters
- T
Parameters
- name: string
- Optional data: T
Returns ParameterDecorator

deprecated

deprecated(enabled?: boolean): PropertyDecorator

- Defined in property-decorators/deprecated.ts:7
Write into console Deprecated warning for a property

Parameters
- Default value enabled: boolean = true
Returns PropertyDecorator

deserialize

deserialize<T>(clazz: object, jsonObject: any): T

- Defined in property-decorators/deserializer.ts:56
Type parameters
- T
Parameters
- clazz: object
  - constructor: function
    - new __type(): T
    - Defined in property-decorators/deserializer.ts:56
      Returns T
- jsonObject: any
Returns T

getClazz

getClazz(target: any, propertyKey: string): any

- Defined in property-decorators/deserializer.ts:34
Parameters
- target: any
- propertyKey: string
Returns any

getJsonProperty

getJsonProperty<T>(target: any, propertyKey: string): JsonMetaData<T>

- Defined in property-decorators/deserializer.ts:38
Type parameters
- T
Parameters
- target: any
- propertyKey: string
Returns JsonMetaData<T>

getMixables

getMixables(clientKeys: string[], mixin: Mixin<any>): PropertyDescriptorMap

- Defined in class-decorators/mixin.ts:25
Returns a map of mixables. That is things that can be mixed in

Parameters
- clientKeys: string[]
- mixin: Mixin<any>
Returns PropertyDescriptorMap

getPropertyDescriptorMap

getPropertyDescriptorMap(clientKeys: string[], object: any): PropertyDescriptorMap

- Defined in class-decorators/mixin.ts:3
Parameters
- clientKeys: string[]
- object: any
Returns PropertyDescriptorMap

isEmail

isEmail(): PropertyDecorator

- Defined in property-decorators/validator.ts:179
Test a parameter that must matching email pattern

Returns PropertyDecorator

jsonProperty

jsonProperty<T>(metadata?: JsonMetaData<T> | string): any

- Defined in property-decorators/deserializer.ts:12
Type parameters
- T
Parameters
- Optional metadata: JsonMetaData<T> | string
Returns any

logMethod

logMethod(enabled?: boolean | Lambda): MethodDecorator

- Defined in method-decorators/logger.ts:30
Log method params and result to console

Parameters
- Default value enabled: boolean | Lambda = true
Returns MethodDecorator

logParameter

logParameter(target: any, key: string, index: number): void

- Defined in method-decorators/logger.ts:9
Log function parameter into console

Parameters
- target: any
- key: string
- index: number
Returns void

logProperty

logProperty(enabled?: boolean | Lambda): PropertyDecorator

- Defined in property-decorators/logger.ts:7
Write into console changes in property

Parameters
- Default value enabled: boolean | Lambda = true
Returns PropertyDecorator

maxLength

maxLength(max: number): PropertyDecorator

- Defined in property-decorators/validator.ts:135
Passed value should not be less than maximum

example

class TestClass { @maxLength(10) testValue: string; }

Parameters
- max: number
  
  A maximum value
Returns PropertyDecorator

maxValue

maxValue(maxValue: number): PropertyDecorator

- Defined in property-decorators/validator.ts:46
Passed value should not be greater than minimum

example

class TestClass { @maxValue(10) testValue: number; }

Parameters
- maxValue: number
  
  A maximum value for validation
Returns PropertyDecorator

minLength

minLength(min: number): PropertyDecorator

- Defined in property-decorators/validator.ts:97
Passed value should not be greater than minimum

example

class TestClass { @minLength(10) testValue: string; }

Parameters
- min: number
  
  A minimum value
Returns PropertyDecorator

minValue

minValue(minValue: number): PropertyDecorator

- Defined in property-decorators/validator.ts:20
Parameters
- minValue: number
Returns PropertyDecorator

mix

mix(client: Constructor<any>, mixins: Mixin<any>[]): void

- Defined in class-decorators/mixin.ts:41
Parameters
- client: Constructor<any>
- mixins: Mixin<any>[]
Returns void

mixin

mixin(...options: Mixin<any>[]): ClassDecorator

- Defined in class-decorators/mixin.ts:53
Takes a list of classes or object literals and adds their methods to the class calling it.

Parameters
- Rest ...options: Mixin<any>[]
Returns ClassDecorator

Const notEmptyString

notEmptyString(): PropertyDecorator
notEmptyString(): ParameterDecorator

- Defined in property-decorators/validator.ts:122
Passed value should not be empty string

example

class TestClass { @notEmptyString() testValue: string; }

Returns PropertyDecorator
- Defined in method-decorators/validator.ts:61
Returns ParameterDecorator

notNull

notNull(target: Record<string, any>, propertyKey: string): void

- Defined in property-decorators/validator.ts:73
Passed value should not be null

example

class TestClass { @notNull testValue: Object; }

Parameters
- target: Record<string, any>
  
  A class of method
- propertyKey: string
  
  A method name
Returns void

Const propertyMetadataFn

propertyMetadataFn(propertyMetadata: any, jsonObject: any, target: any, propertyKey: string): any

- Defined in property-decorators/deserializer.ts:42
Parameters
- propertyMetadata: any
- jsonObject: any
- target: any
- propertyKey: string
Returns any

regex

regex(regex: RegExp | string): PropertyDecorator

- Defined in property-decorators/validator.ts:156
Passed value should be valid in pattern

Parameters
- regex: RegExp | string
  
  RegExp instance or the regular expression literal
Returns PropertyDecorator

serialize

serialize<T>(clazz: T): any

- Defined in property-decorators/deserializer.ts:76
Type parameters
- T
Parameters
- clazz: T
Returns any

tryCatch

tryCatch(func: Lambda1<Error>): (Anonymous function)

- Defined in method-decorators/validator.ts:260
tryCatch decorator

Parameters
- func: Lambda1<Error>
Returns (Anonymous function)

validate

validate(target: any, propertyName: string | symbol, descriptor: PropertyDescriptor): PropertyDescriptor

- Defined in method-decorators/validator.ts:242
Validate method's arguments by rules from rulePool

Parameters
- target: any
- propertyName: string | symbol
- descriptor: PropertyDescriptor
Returns PropertyDescriptor

validateMaxLength

validateMaxLength(target: any, propertyName: string | symbol, arguments_: any): void

- Defined in method-decorators/validator.ts:157
Test decorated parameters for maximal length

Parameters
- target: any
  
  A class of method
- propertyName: string | symbol
  
  A method name
- arguments_: any
Returns void

validateMinLength

validateMinLength(target: any, propertyName: string | symbol, arguments_: any): void

- Defined in method-decorators/validator.ts:182
Test decorated parameters for minimal length

Parameters
- target: any
  
  A class of method
- propertyName: string | symbol
  
  A method name
- arguments_: any
Returns void

validateNulls

validateNulls(target: any, propertyName: string | symbol, arguments_: any): void

- Defined in method-decorators/validator.ts:134
Test decorated parameters for null or undefined

Parameters
- target: any
  
  A class of method
- propertyName: string | symbol
  
  A method name
- arguments_: any
Returns void

validateRegex

validateRegex(target: any, propertyName: string | symbol, arguments_: any): void

- Defined in method-decorators/validator.ts:207
Test decorated parameters for a pattern

Parameters
- target: any
  
  A class of method
- propertyName: string | symbol
  
  A method name
- arguments_: any
Returns void

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Constructor

Type declaration

Mixin

Variables

Const INFO_COLOR

Const WARNING_COLOR

Const jsonMetadataKey

Const maxLengthMetadataKey

Const minLengthMetadataKey

Const regexMetadataKey

Const requiredMetadataKey

Const rulePool

Functions

IsArray

Parameters

object: any

Returns boolean

IsBoolean

Parameters

x: any

Returns boolean

IsFunction

Parameters

x: any

Returns boolean

IsNotNullAndUndefined

Parameters

x: any

Returns boolean

IsNull

Parameters

x: any

Returns boolean

IsNullOrUndefined

Parameters

x: any

Returns boolean

IsNumber

Parameters

x: any

Returns boolean

IsObject

Parameters

x: any

Returns boolean

IsPrimitive

Parameters

x: any

Returns boolean

IsString

Parameters

x: any

Returns boolean

IsSymbol

Parameters

x: any

Returns boolean

IsUndefined

Parameters

x: any

Returns boolean

cached

Returns (Anonymous function)

customValidator

Type parameters

T

Parameters

name: string

Optional data: T

Returns ParameterDecorator

deprecated

Parameters

Default value enabled: boolean = true