EntityConfiguration

@quik/entity

---

@quik/entity / EntityConfiguration

Type Alias: EntityConfiguration

EntityConfiguration = object

Defined in: entity/src/decorators/Entity.ts:14

Configuration options for entity decorators.

Properties

dataEntity?

optional dataEntity?: Constructor<QEntity> | string

Defined in: entity/src/decorators/Entity.ts:30

The entity type to use for data items when paginated

---

isHidden?

optional isHidden?: boolean

Defined in: entity/src/decorators/Entity.ts:22

Whether the entity should be hidden from API responses

---

isPaginated?

optional isPaginated?: boolean

Defined in: entity/src/decorators/Entity.ts:26

Whether the entity should be wrapped in pagination

---

name?

optional name?: string

Defined in: entity/src/decorators/Entity.ts:18

Custom name for the entity

---

schema?

optional schema?: string

Defined in: entity/src/decorators/Entity.ts:34

Optional database schema to qualify the entity's table name with (Postgres only).