Class: Attribute

Defined in: packages/client/src/core/attribute.ts:5

Extends

• Attribute

Constructors

Constructor

new Attribute(classObj, name, type, description?, config?): Attribute

Defined in: packages/client/src/core/attribute.ts:13

Parameters

classObj

null | Class

name

string

type

"string" | "boolean" | "object" | "integer" | "decimal" | "date" | "foreign_key"

description?

string

config?

AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig

Returns

Attribute

Overrides

Attribute_.constructor

Properties

class

class: null | Class

Defined in: packages/client/src/core/attribute.ts:10

Overrides

Attribute_.class

---

defaultValue?

optional defaultValue: any

Defined in: packages/client/src/core/attribute.ts:11

Overrides

Attribute_.defaultValue

---

description?

optional description: string

Defined in: packages/client/src/core/attribute.ts:7

Overrides

Attribute_.description

---

field

field: ZodType

Defined in: packages/client/src/core/attribute.ts:9

Overrides

Attribute_.field

---

model

model: AttributeModel

Defined in: packages/client/src/core/attribute.ts:8

Overrides

Attribute_.model

---

name

name: string

Defined in: packages/client/src/core/attribute.ts:6

Overrides

Attribute_.name

Methods

checkTypeValidity()

checkTypeValidity(type): boolean

Defined in: packages/client/src/core/attribute.ts:226

Parameters

type

string

Returns

boolean

Overrides

Attribute_.checkTypeValidity

---

getClass()

getClass(): Class

Defined in: packages/client/src/core/attribute.ts:176

Returns

Class

Overrides

Attribute_.getClass

---

getEmpty()

getEmpty(): object

Defined in: packages/client/src/core/attribute.ts:211

Returns

object

Overrides

Attribute_.getEmpty

---

getModel()

getModel(): AttributeModel

Defined in: packages/client/src/core/attribute.ts:172

Returns

AttributeModel

Overrides

Attribute_.getModel

---

getName()

getName(): string

Defined in: packages/client/src/core/attribute.ts:222

Returns

string

Overrides

Attribute_.getName

---

getType()

getType(type): "string" | "boolean" | "object" | "integer" | "decimal" | "date" | "foreign_key"

Defined in: packages/client/src/core/attribute.ts:204

Parameters

type

"string" | "boolean" | "object" | "integer" | "decimal" | "date" | "foreign_key"

Returns

"string" | "boolean" | "object" | "integer" | "decimal" | "date" | "foreign_key"

Overrides

Attribute_.getType

---

getTypeConf()

getTypeConf(type, config): AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig

Defined in: packages/client/src/core/attribute.ts:239

Parameters

type

"string" | "boolean" | "object" | "integer" | "decimal" | "date" | "foreign_key"

config

undefined | AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig

Returns

AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig

Overrides

Attribute_.getTypeConf

---

isMandatory()

isMandatory(): boolean

Defined in: packages/client/src/core/attribute.ts:168

Returns

boolean

Overrides

Attribute_.isMandatory

---

isPrimaryKey()

isPrimaryKey(): boolean

Defined in: packages/client/src/core/attribute.ts:163

Returns

boolean

Overrides

Attribute_.isPrimaryKey

---

setField()

setField(): void

Defined in: packages/client/src/core/attribute.ts:31

Returns

void

Overrides

Attribute_.setField

---

setModel()

setModel(model): void

Defined in: packages/client/src/core/attribute.ts:196

Parameters

model

AttributeModel

Returns

void

Overrides

Attribute_.setModel

---

validate()

validate(data): Promise<ZodSafeParseResult<unknown>>

Defined in: packages/client/src/core/attribute.ts:181

Parameters

data

any

Returns

Promise<ZodSafeParseResult<unknown>>

Overrides

Attribute_.validate

---

build()

static build(attributeObj): Promise<Attribute>

Defined in: packages/client/src/core/attribute.ts:185

Parameters

attributeObj

Attribute

Returns

Promise<Attribute>

Overrides

Attribute_.build

---

create()

static create(classObj, name, type, description?, config?): Promise<Attribute>

Defined in: packages/client/src/core/attribute.ts:151

Parameters

classObj

Class

name

string

type

"string" | "boolean" | "object" | "integer" | "decimal" | "date" | "foreign_key"

description?

string

config?

AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig | object & AttributeTypeConfig

Returns

Promise<Attribute>

Overrides

Attribute_.create