routier-collection

---

routier-collection / core/src / SchemaString

Class: SchemaString<T, TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:16

Extends

• SchemaBase<T, TModifiers>

Type Parameters

T

T extends string

TModifiers

TModifiers extends SchemaModifiers

Constructors

Constructor

new SchemaString<T, TModifiers>(entity?, literals?): SchemaString<T, TModifiers>

Defined in: core/src/schema/property/base/SchemaBase.ts:27

Parameters

entity?

SchemaBase<T, TModifiers>

literals?

T[]

Returns

SchemaString<T, TModifiers>

Inherited from

SchemaBase.constructor

Properties

modifiers

modifiers: TModifiers

Defined in: core/src/schema/property/base/SchemaBase.ts:6

Inherited from

SchemaBase.modifiers

---

isNullable

isNullable: boolean = false

Defined in: core/src/schema/property/base/SchemaBase.ts:8

Inherited from

SchemaBase.isNullable

---

isUnmapped

isUnmapped: boolean = false

Defined in: core/src/schema/property/base/SchemaBase.ts:9

Inherited from

SchemaBase.isUnmapped

---

isOptional

isOptional: boolean = false

Defined in: core/src/schema/property/base/SchemaBase.ts:10

Inherited from

SchemaBase.isOptional

---

isKey

isKey: boolean = false

Defined in: core/src/schema/property/base/SchemaBase.ts:11

Inherited from

SchemaBase.isKey

---

isIdentity

isIdentity: boolean = false

Defined in: core/src/schema/property/base/SchemaBase.ts:12

Inherited from

SchemaBase.isIdentity

---

isReadonly

isReadonly: boolean = false

Defined in: core/src/schema/property/base/SchemaBase.ts:13

Inherited from

SchemaBase.isReadonly

---

isDistict

isDistict: boolean = false

Defined in: core/src/schema/property/base/SchemaBase.ts:14

Inherited from

SchemaBase.isDistict

---

indexes

indexes: string[] = []

Defined in: core/src/schema/property/base/SchemaBase.ts:15

Inherited from

SchemaBase.indexes

---

fromPropertyName

fromPropertyName: string = null

Defined in: core/src/schema/property/base/SchemaBase.ts:16

Inherited from

SchemaBase.fromPropertyName

---

injected

injected: any = null

Defined in: core/src/schema/property/base/SchemaBase.ts:18

Inherited from

SchemaBase.injected

---

defaultValue

defaultValue: DefaultValue<T> = null

Defined in: core/src/schema/property/base/SchemaBase.ts:19

Inherited from

SchemaBase.defaultValue

---

valueSerializer

valueSerializer: PropertySerializer<T> = null

Defined in: core/src/schema/property/base/SchemaBase.ts:20

Inherited from

SchemaBase.valueSerializer

---

valueDeserializer

valueDeserializer: PropertyDeserializer<T> = null

Defined in: core/src/schema/property/base/SchemaBase.ts:21

Inherited from

SchemaBase.valueDeserializer

---

functionBody

functionBody: FunctionBody<any, T>

Defined in: core/src/schema/property/base/SchemaBase.ts:23

Inherited from

SchemaBase.functionBody

---

literals

readonly literals: T[] = []

Defined in: core/src/schema/property/base/SchemaBase.ts:25

Inherited from

SchemaBase.literals

---

instance

instance: T

Defined in: core/src/schema/property/types/SchemaString.ts:18

Overrides

SchemaBase.instance

---

type

type: SchemaTypes = SchemaTypes.String

Defined in: core/src/schema/property/types/SchemaString.ts:19

Overrides

SchemaBase.type

Methods

from()

from(propertyName): SchemaFrom<T, TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:22

Parameters

propertyName

string

Returns

SchemaFrom<T, TModifiers>

---

optional()

optional(): SchemaOptional<T, "optional" | TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:26

Returns

SchemaOptional<T, "optional" | TModifiers>

---

nullable()

nullable(): SchemaNullable<T, "nullable" | TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:30

Returns

SchemaNullable<T, "nullable" | TModifiers>

---

key()

key(): SchemaKey<T, "key" | TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:34

Returns

SchemaKey<T, "key" | TModifiers>

---

default()

default<I>(value, injected?): SchemaDefault<T, I, "default" | TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:38

Type Parameters

I

I = never

Parameters

value

DefaultValue<T, I>

injected?

I

Returns

SchemaDefault<T, I, "default" | TModifiers>

---

readonly()

readonly(): SchemaReadonly<T, "readonly" | TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:42

Returns

SchemaReadonly<T, "readonly" | TModifiers>

---

deserialize()

deserialize(deserializer): SchemaDeserialize<T, "deserialize" | TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:46

Parameters

deserializer

PropertyDeserializer<T>

Returns

SchemaDeserialize<T, "deserialize" | TModifiers>

---

serialize()

serialize(serializer): SchemaSerialize<T, "serialize" | TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:50

Parameters

serializer

PropertySerializer<T>

Returns

SchemaSerialize<T, "serialize" | TModifiers>

---

identity()

identity(): SchemaIdentity<T, "identity" | "readonly" | TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:54

Returns

SchemaIdentity<T, "identity" | "readonly" | TModifiers>

---

array()

array(): SchemaArray<SchemaString<T, TModifiers>, TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:58

Returns

SchemaArray<SchemaString<T, TModifiers>, TModifiers>

---

index()

index(…indexes): SchemaIndex<T, TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:62

Parameters

indexes

…string[]

Returns

SchemaIndex<T, TModifiers>

---

distinct()

distinct(): SchemaDistinct<T, "distinct" | TModifiers>

Defined in: core/src/schema/property/types/SchemaString.ts:66

Returns

SchemaDistinct<T, "distinct" | TModifiers>