Class TypedField`Helper`

Объект, содержащий вспомогательные методы для работы с TypedField.

Hierarchy

TypedField

Methods

create

create<V, T>(value: V, type: T): TypedField<T, V>
Создает типизированный контейнер для значения.

Returns
Типизированный контейнер.
Type Parameters
- V extends Primitive
- T extends Boolean | FieldTypeAsString | FieldTypeAsNumber
Parameters
- value: V
  
  Значение.
- type: T
  
  FieldType тип значения.
Returns TypedField<T, V>
- Defined in @tessa/core/src/serialization/typedField.ts:266
create<V, T>(value: null | V, type: T): TypedField<T, V> | null
Type Parameters
- V extends Primitive
- T extends Boolean | FieldTypeAsString | FieldTypeAsNumber
Parameters
- value: null | V
- type: T
Returns TypedField<T, V> | null
- Defined in @tessa/core/src/serialization/typedField.ts:270
create<V, T>(value: undefined | V, type: T): TypedField<T, V> | undefined
Type Parameters
- V extends Primitive
- T extends Boolean | FieldTypeAsString | FieldTypeAsNumber
Parameters
- value: undefined | V
- type: T
Returns TypedField<T, V> | undefined
- Defined in @tessa/core/src/serialization/typedField.ts:274
create<V, T>(value: undefined | null | V, type: T): TypedField<T, V> | null | undefined
Type Parameters
- V extends Primitive
- T extends Boolean | FieldTypeAsString | FieldTypeAsNumber
Parameters
- value: undefined | null | V
- type: T
Returns TypedField<T, V> | null | undefined
- Defined in @tessa/core/src/serialization/typedField.ts:278
create<T, V>(value: V, type: T): TypedField<T, V>
Type Parameters
- T extends FieldType
- V extends string | number | boolean
Parameters
- value: V
- type: T
Returns TypedField<T, V>
- Defined in @tessa/core/src/serialization/typedField.ts:282
create<T, V>(value: null | V, type: T): TypedField<T, V> | null
Type Parameters
- T extends FieldType
- V extends string | number | boolean
Parameters
- value: null | V
- type: T
Returns TypedField<T, V> | null
- Defined in @tessa/core/src/serialization/typedField.ts:286
create<T, V>(value: undefined | V, type: T): TypedField<T, V> | undefined
Type Parameters
- T extends FieldType
- V extends string | number | boolean
Parameters
- value: undefined | V
- type: T
Returns TypedField<T, V> | undefined
- Defined in @tessa/core/src/serialization/typedField.ts:290
create<T, V>(value: undefined | null | V, type: T): TypedField<T, V> | null | undefined
Type Parameters
- T extends FieldType
- V extends string | number | boolean
Parameters
- value: undefined | null | V
- type: T
Returns TypedField<T, V> | null | undefined
- Defined in @tessa/core/src/serialization/typedField.ts:294
create<T, V>(value: TypedField<FieldType, V>, type: T): TypedField<T, V>
Type Parameters
- T extends FieldType
- V extends string | number | boolean
Parameters
- value: TypedField<FieldType, V>
- type: T
Returns TypedField<T, V>
- Defined in @tessa/core/src/serialization/typedField.ts:298
create<T, V>(value: null | TypedField<FieldType, V>, type: T): TypedField<T, V> | null
Type Parameters
- T extends FieldType
- V extends string | number | boolean
Parameters
- value: null | TypedField<FieldType, V>
- type: T
Returns TypedField<T, V> | null
- Defined in @tessa/core/src/serialization/typedField.ts:302
create<T, V>(value: undefined | TypedField<FieldType, V>, type: T): TypedField<T, V> | undefined
Type Parameters
- T extends FieldType
- V extends string | number | boolean
Parameters
- value: undefined | TypedField<FieldType, V>
- type: T
Returns TypedField<T, V> | undefined
- Defined in @tessa/core/src/serialization/typedField.ts:306
create<T, V>(value: undefined | null | TypedField<FieldType, V>, type: T): TypedField<T, V> | null | undefined
Type Parameters
- T extends FieldType
- V extends string | number | boolean
Parameters
- value: undefined | null | TypedField<FieldType, V>
- type: T
Returns TypedField<T, V> | null | undefined
- Defined in @tessa/core/src/serialization/typedField.ts:310

createBoolean

createBoolean(value: boolean): TypedField<Boolean, boolean>
Создает типизированный контейнер для значения с типом Boolean.

Returns
Типизированный контейнер.
Parameters
- value: boolean
  
  Значение.
Returns TypedField<Boolean, boolean>
- Defined in @tessa/core/src/serialization/typedField.ts:428

createDateTime

createDateTime(value: string): TypedField<DateTime, string>
Создает типизированный контейнер для значения с типом DateTime.

Returns
Типизированный контейнер.
Parameters
- value: string
  
  Значение.
Returns TypedField<DateTime, string>
- Defined in @tessa/core/src/serialization/typedField.ts:454

createDecimal

createDecimal(value: string): TypedField<Decimal, string>
Создает типизированный контейнер для значения с типом Decimal.

Returns
Типизированный контейнер.
Parameters
- value: string
  
  Значение.
Returns TypedField<Decimal, string>
- Defined in @tessa/core/src/serialization/typedField.ts:463

createDouble

createDouble(value: number): TypedField<Double, number>
Создает типизированный контейнер для значения с типом Double.

Returns
Типизированный контейнер.
Parameters
- value: number
  
  Значение.
Returns TypedField<Double, number>
- Defined in @tessa/core/src/serialization/typedField.ts:419

createFloat

createFloat(value: number): TypedField<Float, number>
Создает типизированный контейнер для значения с типом Float.

Returns
Типизированный контейнер.
Parameters
- value: number
  
  Значение.
Returns TypedField<Float, number>
- Defined in @tessa/core/src/serialization/typedField.ts:410

createGuid

createGuid(value: string): TypedField<Guid, string>
Создает типизированный контейнер для значения с типом Guid.

Returns
Типизированный контейнер.
Parameters
- value: string
  
  Значение.
Returns TypedField<Guid, string>
- Defined in @tessa/core/src/serialization/typedField.ts:437

createInt

createInt(value: number): TypedField<Int, number>
Создает типизированный контейнер для значения с типом Int.

Returns
Типизированный контейнер.
Parameters
- value: number
  
  Значение.
Returns TypedField<Int, number>
- Defined in @tessa/core/src/serialization/typedField.ts:392

createLong

createLong(value: number): TypedField<Long, number>
Создает типизированный контейнер для значения с типом Long.

Returns
Типизированный контейнер.
Parameters
- value: number
  
  Значение.
Returns TypedField<Long, number>
- Defined in @tessa/core/src/serialization/typedField.ts:401

createNewGuid

createNewGuid(): TypedField<Guid, string>
Создает типизированный контейнер со значением Guid.newGuid() и с типом Guid.

Returns
Типизированный контейнер.

Returns TypedField<Guid, string>
- Defined in @tessa/core/src/serialization/typedField.ts:445

createNumber

createNumber(value: number): TypedField<Long, number>
Создает типизированный контейнер для значения с типом Long.

Returns
Типизированный контейнер.
Parameters
- value: number
  
  Значение.
Returns TypedField<Long, number>
- Defined in @tessa/core/src/serialization/typedField.ts:383

createString

createString(value: string): TypedField<String, string>
Создает типизированный контейнер для значения с типом String.

Returns
Типизированный контейнер.
Parameters
- value: string
  
  Значение.
Returns TypedField<String, string>
- Defined in @tessa/core/src/serialization/typedField.ts:374

createUnsafe

createUnsafe(value: undefined | null | Primitive, type: FieldType): TypedField | null | undefined
Создает типизированный контейнер для значения без статических и динамических проверок.

Returns
Типизированный контейнер.

Remarks
Следует использовать только в особых случаях и с осторожностью.
Parameters
- value: undefined | null | Primitive
  
  Значение.
- type: FieldType
  
  Контейнер с типом.
Returns TypedField | null | undefined
- Defined in @tessa/core/src/serialization/typedField.ts:362

createWithType

createWithType<V, T>(value: V, field: undefined | null | TypedField<T, JsTypeFromFieldType<T>>): TypedFieldFromValue<V, T>
Создает типизированный контейнер для значения c типом из другого типизированного контейнера.

Returns
Типизированный контейнер.
Type Parameters
- V extends Primitive
- T extends Boolean | FieldTypeAsString | FieldTypeAsNumber
Parameters
- value: V
  
  Значение.
- field: undefined | null | TypedField<T, JsTypeFromFieldType<T>>
Returns TypedFieldFromValue<V, T>
- Defined in @tessa/core/src/serialization/typedField.ts:327
createWithType<V, T>(value: null | V, field: undefined | null | TypedField<T, JsTypeFromFieldType<T>>): TypedFieldFromValue<V, T> | null
Type Parameters
- V extends Primitive
- T extends Boolean | FieldTypeAsString | FieldTypeAsNumber
Parameters
- value: null | V
- field: undefined | null | TypedField<T, JsTypeFromFieldType<T>>
Returns TypedFieldFromValue<V, T> | null
- Defined in @tessa/core/src/serialization/typedField.ts:331
createWithType<V, T>(value: undefined | V, field: undefined | null | TypedField<T, JsTypeFromFieldType<T>>): TypedFieldFromValue<V, T> | undefined
Type Parameters
- V extends Primitive
- T extends Boolean | FieldTypeAsString | FieldTypeAsNumber
Parameters
- value: undefined | V
- field: undefined | null | TypedField<T, JsTypeFromFieldType<T>>
Returns TypedFieldFromValue<V, T> | undefined
- Defined in @tessa/core/src/serialization/typedField.ts:335
createWithType<V, T>(value: undefined | null | V, field: undefined | null | TypedField<T, JsTypeFromFieldType<T>>): TypedFieldFromValue<V, T> | null | undefined
Type Parameters
- V extends Primitive
- T extends Boolean | FieldTypeAsString | FieldTypeAsNumber
Parameters
- value: undefined | null | V
- field: undefined | null | TypedField<T, JsTypeFromFieldType<T>>
Returns TypedFieldFromValue<V, T> | null | undefined
- Defined in @tessa/core/src/serialization/typedField.ts:339

equals

equals(a: undefined | null | TypedField<FieldType, string | number | boolean>, b: undefined | null | TypedField<FieldType, string | number | boolean>): boolean
Сравнивает объекты и возвращает true если объекты соответствуют типу TypedField, а так же равны по значению и FieldType типу. Или оба значения равны null. Возвращает false в противном случае.

Returns
true если объекты соответствуют типу TypedField, а так же равны по значению и FieldType типу; false в противном случае.
Parameters
- a: undefined | null | TypedField<FieldType, string | number | boolean>
  
  Первый объект сравнения.
- b: undefined | null | TypedField<FieldType, string | number | boolean>
  
  Второй объект сравнения.
Returns boolean
- Defined in @tessa/core/src/serialization/typedField.ts:793

get

get<T, V>(field: TypedField<T, V>): V
Извлекает значение из типизированного контейнера.

Returns
Значение.

Remarks
Кидается исключение если контейнер не соответствует типу TypedField.
Type Parameters
- T extends FieldType
- V extends Primitive = JsTypeFromFieldType<T>
Parameters
- field: TypedField<T, V>
  
  Типизированный контейнер.
Returns V
- Defined in @tessa/core/src/serialization/typedField.ts:518
get<V>(field: TypedFieldFromValue<V, FieldTypeFromJsType<V>>): V
Type Parameters
- V extends Primitive
Parameters
- field: TypedFieldFromValue<V, FieldTypeFromJsType<V>>
Returns V
- Defined in @tessa/core/src/serialization/typedField.ts:521
get<T>(field: TypedField<FieldType, string | number | boolean>, type: T): JsTypeFromFieldType<T>
Type Parameters
- T extends FieldType
Parameters
- field: TypedField<FieldType, string | number | boolean>
- type: T
Returns JsTypeFromFieldType<T>
- Defined in @tessa/core/src/serialization/typedField.ts:522

getBoolean

getBoolean(field: TypedField<FieldType, string | number | boolean>): boolean
Извлекает значение типа boolean из типизированного контейнера.

Returns
Значение типа boolean.

Remarks
Кидается исключение если значение в контейнере не соответствует типу boolean.
Parameters
- field: TypedField<FieldType, string | number | boolean>
  
  Типизированный контейнер.
Returns boolean
- Defined in @tessa/core/src/serialization/typedField.ts:582

getDefaultType

getDefaultType<T, V>(value: V): T
Возвращает стандартный FieldType тип для заданного значения.

Returns
Стандартный FieldType тип для заданного значения.
Type Parameters
- T extends String | Long | Boolean
- V extends Primitive
Parameters
- value: V
  
  Значение, для которого нужно вернуть тип.
Returns T
- Defined in @tessa/core/src/serialization/typedField.ts:834

getDefaultValue

getDefaultValue(type: FieldType): Primitive
Возвращает дефолтное значение для заданного типа.

Returns
Дефолтное значение.
Parameters
- type: FieldType
  
  Тип поля.
Returns Primitive
- Defined in @tessa/core/src/serialization/typedField.ts:882

getNumber

getNumber(field: TypedField<FieldType, string | number | boolean>): number
Извлекает значение типа number из типизированного контейнера.

Returns
Значение типа number.

Remarks
Кидается исключение если значение в контейнере не соответствует типу number.
Parameters
- field: TypedField<FieldType, string | number | boolean>
  
  Типизированный контейнер.
Returns number
- Defined in @tessa/core/src/serialization/typedField.ts:568

getString

getString(field: TypedField<FieldType, string | number | boolean>): string
Извлекает значение типа string из типизированного контейнера.

Returns
Значение типа string.

Remarks
Кидается исключение если значение в контейнере не соответствует типу string.
Parameters
- field: TypedField<FieldType, string | number | boolean>
  
  Типизированный контейнер.
Returns string
- Defined in @tessa/core/src/serialization/typedField.ts:554

getType

getType<T>(field: TypedField<T, JsTypeFromFieldType<T>>): T
Извлекает тип из типизированного контейнера.

Returns
Тип.

Remarks
Кидается исключение если контейнер не соответствует типу TypedField.
Type Parameters
- T extends FieldType
Parameters
- field: TypedField<T, JsTypeFromFieldType<T>>
  
  Типизированный контейнер.
Returns T
- Defined in @tessa/core/src/serialization/typedField.ts:596
getType<T>(field: TypedField<FieldType, string | number | boolean>, type: T): T
Type Parameters
- T extends FieldType
Parameters
- field: TypedField<FieldType, string | number | boolean>
- type: T
Returns T
- Defined in @tessa/core/src/serialization/typedField.ts:597

isTypedField

isTypedField<T, V>(obj: unknown, type?: T): obj is TypedField<T, V>
Проверяет, что объект соответствует типу TypedField. Стандартные типы, которые можно получить tryGetDefaultType тоже считаются валидным TypedField.

Returns
true если объект соответствует типу TypedField; false в противном случае.
Type Parameters
- T extends FieldType
- V extends string | number | boolean = JsTypeFromFieldType<T>
Parameters
- obj: unknown
  
  Объект, который нужно проверить.
- Optional type: T
  
  Тип контейнера, который нужно проверить.
Returns obj is TypedField<T, V>
- Defined in @tessa/core/src/serialization/typedField.ts:743

isTypedFieldContainer

isTypedFieldContainer<T, V>(obj: unknown, type?: T): obj is TypedField<T, V>
Проверяет, что объект соответствует типу TypedField и явно является контейнером.

Returns
true если объект соответствует типу TypedField и явно является контейнером; false в противном случае.
Type Parameters
- T extends FieldType
- V extends string | number | boolean = JsTypeFromFieldType<T>
Parameters
- obj: unknown
  
  Объект, который нужно проверить.
- Optional type: T
  
  Тип контейнера, который нужно проверить.
Returns obj is TypedField<T, V>
- Defined in @tessa/core/src/serialization/typedField.ts:771

tryCreateByValueType

tryCreateByValueType(value: undefined | null | Primitive): TypedField | null
Создает типизированный контейнер и пытается вычислить подходящий тип FieldType по типу значения.

Returns
Типизированный контейнер или null если создать контейнер не удалось.
Parameters
- value: undefined | null | Primitive
  
  Значение.
Returns TypedField | null
- Defined in @tessa/core/src/serialization/typedField.ts:472

tryGet

tryGet<T, V>(field: undefined | null | TypedField<T, V>): V | null
Извлекает значение из типизированного контейнера или null если контейнер не существует. или не соответствует TypedField.

Returns
Значение или null если контейнер не соответствует типу TypedField.
Type Parameters
- T extends FieldType
- V extends Primitive = JsTypeFromFieldType<T>
Parameters
- field: undefined | null | TypedField<T, V>
  
  Типизированный контейнер.
Returns V | null
- Defined in @tessa/core/src/serialization/typedField.ts:629
tryGet<V>(field: undefined | null | TypedFieldFromValue<V, FieldTypeFromJsType<V>>): V | null
Type Parameters
- V extends Primitive
Parameters
- field: undefined | null | TypedFieldFromValue<V, FieldTypeFromJsType<V>>
Returns V | null
- Defined in @tessa/core/src/serialization/typedField.ts:632
tryGet<T>(field: undefined | null | TypedField<FieldType, string | number | boolean>, type: T): JsTypeFromFieldType<T> | null
Type Parameters
- T extends FieldType
Parameters
- field: undefined | null | TypedField<FieldType, string | number | boolean>
- type: T
Returns JsTypeFromFieldType<T> | null
- Defined in @tessa/core/src/serialization/typedField.ts:635

tryGetBoolean

tryGetBoolean(field: undefined | null | TypedField<FieldType, string | number | boolean>): boolean | null
Извлекает значение типа boolean из типизированного контейнера или null если контейнер не существует или тип значения не соответствует boolean.
Parameters
- field: undefined | null | TypedField<FieldType, string | number | boolean>
  
  Типизированный контейнер.
Returns boolean | null
- Defined in @tessa/core/src/serialization/typedField.ts:689

tryGetDefaultType

tryGetDefaultType<T, V>(value: undefined | null | V): T | null
Возвращает стандартный FieldType тип для заданного значения или null если такой тип получить невозможно.

Returns
Стандартный FieldType тип для заданного значения или null если такой тип получить невозможно.
Type Parameters
- T extends String | Long | Boolean
- V extends Primitive
Parameters
- value: undefined | null | V
  
  Значение, для которого нужно вернуть тип.
Returns T | null
- Defined in @tessa/core/src/serialization/typedField.ts:858

tryGetNumber

tryGetNumber(field: undefined | null | TypedField<FieldType, string | number | boolean>): number | null
Извлекает значение типа number из типизированного контейнера или null если контейнер не существует или тип значения не соответствует number.
Parameters
- field: undefined | null | TypedField<FieldType, string | number | boolean>
  
  Типизированный контейнер.
Returns number | null
- Defined in @tessa/core/src/serialization/typedField.ts:679

tryGetString

tryGetString(field: undefined | null | TypedField<FieldType, string | number | boolean>): string | null
Извлекает значение типа string из типизированного контейнера или null если контейнер не существует или тип значения не соответствует string.
Parameters
- field: undefined | null | TypedField<FieldType, string | number | boolean>
  
  Типизированный контейнер.
Returns string | null
- Defined in @tessa/core/src/serialization/typedField.ts:669

tryGetType

tryGetType<T>(field: undefined | null | TypedField<T, JsTypeFromFieldType<T>>): T | null
Извлекает тип из типизированного контейнера или null если контейнер не существует или не соответствует TypedField.

Returns
Тип или null если контейнер не соответствует типу TypedField.
Type Parameters
- T extends FieldType
Parameters
- field: undefined | null | TypedField<T, JsTypeFromFieldType<T>>
  
  Типизированный контейнер.
Returns T | null
- Defined in @tessa/core/src/serialization/typedField.ts:700
tryGetType<T>(field: undefined | null | TypedField<FieldType, string | number | boolean>, type: T): T | null
Type Parameters
- T extends FieldType
Parameters
- field: undefined | null | TypedField<FieldType, string | number | boolean>
- type: T
Returns T | null
- Defined in @tessa/core/src/serialization/typedField.ts:703

validate

validate(type: FieldType, value: Primitive): boolean
Проверяет, что тип значения и тип поля соответствуют друг-другу.

Returns
Результат валидации.
Parameters
- type: FieldType
  
  Тип поля.
- value: Primitive
  
  Значение.
Returns boolean
- Defined in @tessa/core/src/serialization/typedField.ts:916

Class TypedFieldHelper

Hierarchy

Index

Variables

Methods

Methods

create

Returns

Type Parameters

V extends Primitive

T extends Boolean | FieldTypeAsString | FieldTypeAsNumber

Parameters

value: V

type: T

Returns TypedField<T, V>

Type Parameters

V extends Primitive

T extends Boolean | FieldTypeAsString | FieldTypeAsNumber

Parameters

value: null | V

type: T

Returns TypedField<T, V> | null

Type Parameters

V extends Primitive

T extends Boolean | FieldTypeAsString | FieldTypeAsNumber

Parameters

value: undefined | V

type: T

Returns TypedField<T, V> | undefined

Type Parameters

V extends Primitive

T extends Boolean | FieldTypeAsString | FieldTypeAsNumber

Parameters

value: undefined | null | V

type: T

Returns TypedField<T, V> | null | undefined

Type Parameters

T extends FieldType

V extends string | number | boolean

Parameters

value: V

type: T

Returns TypedField<T, V>

Type Parameters

T extends FieldType

V extends string | number | boolean

Parameters

value: null | V

type: T

Returns TypedField<T, V> | null

Type Parameters

T extends FieldType

V extends string | number | boolean

Parameters

value: undefined | V

type: T

Returns TypedField<T, V> | undefined

Type Parameters

T extends FieldType

V extends string | number | boolean

Parameters

value: undefined | null | V

type: T

Returns TypedField<T, V> | null | undefined

Type Parameters

T extends FieldType

V extends string | number | boolean

Parameters

value: TypedField<FieldType, V>

type: T

Returns TypedField<T, V>

Type Parameters

T extends FieldType

V extends string | number | boolean

Parameters

value: null | TypedField<FieldType, V>

type: T

Returns TypedField<T, V> | null

Type Parameters

T extends FieldType

Class TypedField`Helper`