Class: Class

Defined in: server/src/utils/stack/class.ts:20

Extends

• Class

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
addCards	abstract	(paramsArray) => Promise<Document[]>	undefined	-	Class_.addCards	shared/src/utils/stack/class/index.ts:157
attributes	public	object	{}	Class_.attributes	-	server/src/utils/stack/class.ts:27
bulkUniqueCheck	abstract	(pks) => Promise<boolean>	undefined	-	Class_.bulkUniqueCheck	shared/src/utils/stack/class/index.ts:122
description?	public	string	undefined	Class_.description	-	server/src/utils/stack/class.ts:26
getByPrimaryKeys	abstract	(params) => Promise<Document>	undefined	-	Class_.getByPrimaryKeys	shared/src/utils/stack/class/index.ts:116
getEncryptedAttributes	abstract	() => Attribute[]	undefined	-	Class_.getEncryptedAttributes	shared/src/utils/stack/class/index.ts:147
getStack	abstract	() => Stack	undefined	-	Class_.getStack	shared/src/utils/stack/class/index.ts:108
id?	public	string	undefined	Class_.id	-	server/src/utils/stack/class.ts:30
logger	public	Logger	undefined	Class_.logger	-	server/src/utils/stack/class.ts:35
model	public	ClassModel	undefined	Class_.model	-	server/src/utils/stack/class.ts:32
modifyAttribute	abstract	(name, attribute) => Promise<Class>	undefined	-	Class_.modifyAttribute	shared/src/utils/stack/class/index.ts:143
name	public	string	undefined	Class_.name	-	server/src/utils/stack/class.ts:23
push	abstract	(params, cardId?) => Promise<Document>	undefined	-	Class_.push	shared/src/utils/stack/class/index.ts:160
removeAttribute	abstract	(name) => Promise<Class>	undefined	-	Class_.removeAttribute	shared/src/utils/stack/class/index.ts:145
schema	public	object	{}	Class_.schema	-	server/src/utils/stack/class.ts:28
schemaZOD	public	ZodObject	undefined	Class_.schemaZOD	-	server/src/utils/stack/class.ts:29
space	public	Stack	undefined	-	-	server/src/utils/stack/class.ts:21
stack	public	Stack	undefined	-	Class_.stack	shared/src/utils/stack/class/index.ts:14
state	public	"busy" | "idle"	"idle"	Class_.state	-	server/src/utils/stack/class.ts:33
triggers	public	Trigger[]	[]	Class_.triggers	-	server/src/utils/stack/class.ts:36
type	public	string	undefined	Class_.type	-	server/src/utils/stack/class.ts:25
uniqueCheck	abstract	(doc) => Promise<boolean>	undefined	-	Class_.uniqueCheck	shared/src/utils/stack/class/index.ts:120
validate	abstract	(data) => Promise<boolean>	undefined	-	Class_.validate	shared/src/utils/stack/class/index.ts:118
fetchById	static	(stack, classId) => Promise<Class>	undefined	-	Class_.fetchById	shared/src/utils/stack/class/index.ts:99
logger	static	Logger	undefined	Class_.logger	-	server/src/utils/stack/class.ts:34

Methods

add()

Call Signature

abstract add(params): Promise<Document>;

Defined in: shared/src/utils/stack/class/index.ts:149

Parameters

Parameter	Type
params	{ [key: string]: any; }

Returns

Promise<Document>

Inherited from

Class_.add

Call Signature

abstract add(...paramsArray): Promise<Document[]>;

Defined in: shared/src/utils/stack/class/index.ts:150

Parameters

Parameter	Type
...paramsArray	object[]

Returns

Promise<Document[]>

Inherited from

Class_.add

Call Signature

abstract add(...paramsArray): Promise<Document | Document[]>;

Defined in: shared/src/utils/stack/class/index.ts:151

Parameters

Parameter	Type
...paramsArray	object[]

Returns

Promise<Document | Document[]>

Inherited from

Class_.add

---

addAttribute()

addAttribute(attribute): Promise<Class>;

Defined in: server/src/utils/stack/class.ts:308

Parameters

Parameter	Type
attribute	Attribute

Returns

Promise<Class>

Overrides

Class_.addAttribute

---

addCard()

addCard(params): Promise<Document>;

Defined in: server/src/utils/stack/class.ts:341

Parameters

Parameter	Type
params	{ [key: string]: any; }

Returns

Promise<Document>

Overrides

Class_.addCard

---

addOrUpdateCard()

addOrUpdateCard(params, cardId?): Promise<Document>;

Defined in: server/src/utils/stack/class.ts:345

Parameters

Parameter	Type
params	{ [key: string]: any; }
cardId?	string

Returns

Promise<Document>

Overrides

Class_.addOrUpdateCard

---

addTrigger()

addTrigger(name, model): Promise<Class>;

Defined in: server/src/utils/stack/class.ts:414

Parameters

Parameter	Type
name	string
model	TriggerModel

Returns

Promise<Class>

Overrides

Class_.addTrigger

---

build()

build(): Promise<Class>;

Defined in: server/src/utils/stack/class.ts:54

Returns

Promise<Class>

Overrides

Class_.build

---

buildSchema()

buildSchema(): object;

Defined in: server/src/utils/stack/class.ts:196

Returns

object

Overrides

Class_.buildSchema

---

close()

close(): void;

Defined in: shared/src/utils/stack/class/index.ts:55

Releases this instance's live document subscription.

Subscribing is not free: the handle keeps its handler - and everything that handler closes over - reachable for as long as the stack lives. Close a Class that was built outside the stack's cache (getClass(name, true), or an entry a class list has replaced) once it is no longer needed. Afterwards the instance stops emitting doc events; its data methods still work. Safe to call twice.

Returns

void

Example

const snapshot = await stack.getClass('Task', true);
// ...
snapshot.close();

Inherited from

Class_.close

---

deleteCard()

deleteCard(cardId): Promise<boolean>;

Defined in: server/src/utils/stack/class.ts:396

Parameters

Parameter	Type
cardId	string

Returns

Promise<boolean>

Overrides

Class_.deleteCard

---

get()

Call Signature

abstract get(cardId): Promise<Document>;

Defined in: shared/src/utils/stack/class/index.ts:164

Parameters

Parameter	Type
cardId	string

Returns

Promise<Document>

Inherited from

Class_.get

Call Signature

abstract get(...cardId): Promise<Document[]>;

Defined in: shared/src/utils/stack/class/index.ts:165

Parameters

Parameter	Type
...cardId	string[]

Returns

Promise<Document[]>

Inherited from

Class_.get

Call Signature

abstract get(...cardId): Promise<Document | Document[]>;

Defined in: shared/src/utils/stack/class/index.ts:166

Parameters

Parameter	Type
...cardId	string[]

Returns

Promise<Document | Document[]>

Inherited from

Class_.get

---

getAttributes()

getAttributes(...names): object;

Defined in: server/src/utils/stack/class.ts:263

Parameters

Parameter	Type
...names	string[]

Returns

object

Overrides

Class_.getAttributes

---

getCards()

getCards(
   selector?, 
   fields?, 
   skip?, 
limit?): Promise<(Document | RelationDocument)[]>;

Defined in: server/src/utils/stack/class.ts:407

Parameters

Parameter	Type
selector?	{ [key: string]: any; }
fields?	string[]
skip?	number
limit?	number

Returns

Promise<(Document | RelationDocument)[]>

Overrides

Class_.getCards

---

getDescription()

getDescription(): string;

Defined in: server/src/utils/stack/class.ts:184

Returns

string

Overrides

Class_.getDescription

---

getId()

getId(): string;

Defined in: server/src/utils/stack/class.ts:192

Returns

string

Overrides

Class_.getId

---

getModel()

getModel(): ClassModel;

Defined in: server/src/utils/stack/class.ts:204

Returns

ClassModel

Overrides

Class_.getModel

---

getName()

getName(): string;

Defined in: server/src/utils/stack/class.ts:176

Returns

string

Overrides

Class_.getName

---

getPrimaryKeys()

getPrimaryKeys(): string[];

Defined in: server/src/utils/stack/class.ts:258

Returns

string[]

Overrides

Class_.getPrimaryKeys

---

getSpace()

getSpace(): Stack;

Defined in: server/src/utils/stack/class.ts:180

Returns

Stack

---

getType()

getType(): string;

Defined in: server/src/utils/stack/class.ts:188

Returns

string

Overrides

Class_.getType

---

hasAllAttributes()

hasAllAttributes(...names): boolean;

Defined in: server/src/utils/stack/class.ts:282

Parameters

Parameter	Type
...names	string[]

Returns

boolean

Overrides

Class_.hasAllAttributes

---

hasAnyAttributes()

hasAnyAttributes(...names): boolean;

Defined in: server/src/utils/stack/class.ts:292

Parameters

Parameter	Type
...names	string[]

Returns

boolean

Overrides

Class_.hasAnyAttributes

---

hasAttribute()

hasAttribute(name): boolean;

Defined in: server/src/utils/stack/class.ts:303

Parameters

Parameter	Type
name	string

Returns

boolean

Overrides

Class_.hasAttribute

---

init()

init(
   space, 
   name, 
   type, 
   description?, 
   schema?): void;

Defined in: server/src/utils/stack/class.ts:76

Parameters

Parameter	Type
space	Stack
name	string
type	string
description?	string
schema?	{ [name: string]: AttributeModel; }

Returns

void

Overrides

Class_.init

---

removeTrigger()

removeTrigger(name): Promise<Class>;

Defined in: server/src/utils/stack/class.ts:431

Parameters

Parameter	Type
name	string

Returns

Promise<Class>

Overrides

Class_.removeTrigger

---

setId()

setId(id): void;

Defined in: server/src/utils/stack/class.ts:172

Parameters

Parameter	Type
id	string

Returns

void

Overrides

Class_.setId

---

setModel()

setModel(model?): void;

Defined in: server/src/utils/stack/class.ts:228

It hydrates attributes and triggers from given model

Parameters

Parameter	Type	Description
model?	ClassModel

Returns

void

Overrides

Class_.setModel

---

updateCard()

updateCard(cardId, params): Promise<Document>;

Defined in: server/src/utils/stack/class.ts:384

Parameters

Parameter	Type
cardId	string
params	{ [key: string]: any; }

Returns

Promise<Document>

Overrides

Class_.updateCard

---

buildFromModel()

static buildFromModel(space, classModel): Promise<Class>;

Defined in: server/src/utils/stack/class.ts:141

Parameters

Parameter	Type
space	Stack
classModel	ClassModel

Returns

Promise<Class>

Overrides

Class_.buildFromModel

---

create()

static create(
   space, 
   name, 
   type, 
   description?, 
schema?): Promise<Class>;

Defined in: server/src/utils/stack/class.ts:128

Parameters

Parameter	Type	Default value
space	Stack	undefined
name	string	undefined
type	string	"class"
description?	string	undefined
schema?	{ [name: string]: AttributeModel; }	{}

Returns

Promise<Class>

Overrides

Class_.create

---

fetch()

static fetch(space, className): Promise<Class>;

Defined in: server/src/utils/stack/class.ts:161

Parameters

Parameter	Type
space	Stack
className	string

Returns

Promise<Class>

Overrides

Class_.fetch

---

get()

static get(
   space, 
   name, 
   type, 
   description?, 
   schema?): Class;

Defined in: server/src/utils/stack/class.ts:107

Parameters

Parameter	Type	Default value
space	Stack	undefined
name	string	undefined
type	string	"class"
description?	string	undefined
schema?	{ [name: string]: AttributeModel; }	{}

Returns

Class

Overrides

Class_.get