Skip to main content

Class: Attribute

Defined in: packages/server/src/utils/stack/attribute.ts:4

Extends​

  • Attribute

Constructors​

Constructor​

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

Defined in: packages/server/src/utils/stack/attribute.ts:10

Parameters​

classObj​

Class = null

name​

string

type​

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

config?​

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

Returns​

Attribute

Overrides​

Attribute_.constructor

Properties​

class​

class: Class

Defined in: packages/server/src/utils/stack/attribute.ts:7

Overrides​

Attribute_.class

defaultValue?​

optional defaultValue: any

Defined in: packages/server/src/utils/stack/attribute.ts:8

Overrides​

Attribute_.defaultValue

model​

model: AttributeModel

Defined in: packages/server/src/utils/stack/attribute.ts:6

Overrides​

Attribute_.model

name​

name: string

Defined in: packages/server/src/utils/stack/attribute.ts:5

Overrides​

Attribute_.name

Methods​

checkTypeValidity()​

checkTypeValidity(type): boolean

Defined in: packages/server/src/utils/stack/attribute.ts:82

Parameters​

type​

string

Returns​

boolean

Overrides​

Attribute_.checkTypeValidity

getClass()​

getClass(): Class

Defined in: packages/server/src/utils/stack/attribute.ts:45

Returns​

Class

Overrides​

Attribute_.getClass

getModel()​

getModel(): AttributeModel

Defined in: packages/server/src/utils/stack/attribute.ts:41

Returns​

AttributeModel

Overrides​

Attribute_.getModel

getName()​

getName(): string

Defined in: packages/server/src/utils/stack/attribute.ts:78

Returns​

string

Overrides​

Attribute_.getName

getType()​

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

Defined in: packages/server/src/utils/stack/attribute.ts:69

Parameters​

type​

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

Returns​

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

Overrides​

Attribute_.getType

getTypeConf()​

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

Defined in: packages/server/src/utils/stack/attribute.ts:95

Parameters​

type​

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

config​

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

Returns​

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

Overrides​

Attribute_.getTypeConf

isPrimaryKey()​

isPrimaryKey(): boolean

Defined in: packages/server/src/utils/stack/attribute.ts:36

Returns​

boolean

Overrides​

Attribute_.isPrimaryKey

setModel()​

setModel(model): void

Defined in: packages/server/src/utils/stack/attribute.ts:61

Parameters​

model​

AttributeModel

Returns​

void

Overrides​

Attribute_.setModel

build()​

static build(attributeObj): Promise<Attribute>

Defined in: packages/server/src/utils/stack/attribute.ts:50

Parameters​

attributeObj​

Attribute

Returns​

Promise<Attribute>

Overrides​

Attribute_.build

create()​

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

Defined in: packages/server/src/utils/stack/attribute.ts:25

Parameters​

classObj​

Class

name​

string

type​

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

config?​

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

Returns​

Promise<Attribute>

Overrides​

Attribute_.create