routier-collection

---

routier-collection / core/src / SchemaObject

Class: SchemaObject<T, TModifiers>

Defined in: core/src/schema/property/types/SchemaObject.ts:10

Extends

• SchemaBase<T, TModifiers>

Type Parameters

T

T extends object

TModifiers

TModifiers extends SchemaModifiers

Constructors

Constructor

new SchemaObject<T, TModifiers>(schema): SchemaObject<T, TModifiers>

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

Parameters

schema

T

Returns

SchemaObject<T, TModifiers>

Overrides

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/SchemaObject.ts:12

Overrides

SchemaBase.instance

---

type

type: SchemaTypes = SchemaTypes.Object

Defined in: core/src/schema/property/types/SchemaObject.ts:13

Overrides

SchemaBase.type

Methods

from()

from(propertyName): SchemaFrom<T, TModifiers>

Defined in: core/src/schema/property/types/SchemaObject.ts:21

Parameters

propertyName

string

Returns

SchemaFrom<T, TModifiers>

---

optional()

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

Defined in: core/src/schema/property/types/SchemaObject.ts:25

Returns

SchemaOptional<T, "optional" | TModifiers>

---

nullable()

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

Defined in: core/src/schema/property/types/SchemaObject.ts:29

Returns

SchemaNullable<T, "nullable" | TModifiers>

---

default()

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

Defined in: core/src/schema/property/types/SchemaObject.ts:33

Type Parameters

I

I = never

Parameters

value

DefaultValue<T, I>

injected?

I

Returns

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

---

identity()

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

Defined in: core/src/schema/property/types/SchemaObject.ts:37

Returns

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

---

array()

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

Defined in: core/src/schema/property/types/SchemaObject.ts:41

Returns

SchemaArray<SchemaObject<T, TModifiers>, TModifiers>