Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TypeEnum

Hierarchy

Index

Constructors

constructor

  • new TypeEnum(availableValues?: any[]): TypeEnum
  • Parameters

    • Default value availableValues: any[] = []

    Returns TypeEnum

Methods

allowNull

  • allowNull(): boolean
  • Returns whether null values are okay

    Returns boolean

deserialize

  • deserialize(value: any, targetObject: any, targetKey: any, root: any): void
  • see

    BaseDataType.deserialize

    Parameters

    • value: any
    • targetObject: any
    • targetKey: any
    • root: any

    Returns void

    String error code or null on success

deserializeWithVerify

  • deserializeWithVerify(value: any, targetObject: any, targetKey: any, root: any): string | void
  • Deserializes a serialized value, but performs integrity checks before

    Parameters

    • value: any
    • targetObject: any
    • targetKey: any
    • root: any

    Returns string | void

    String error code or null on success

getAsJsonSchema

  • getAsJsonSchema(): object
  • Returns the json schema

    Returns object

    • $ref: string

getAsJsonSchemaUncached

  • getAsJsonSchemaUncached(): object

getCacheKey

  • getCacheKey(): string

serialize

  • serialize(value: any): any
  • Parameters

    • value: any

    Returns any

verifySerializedValue

  • verifySerializedValue(value: any): string