Skip to content

Interface: AspectType

@flyze/lib-data-store 3.0.0-alpha.55· latest

Defined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:3

  • AspectTypeDTO

optional __v: number

Defined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:13


optional _id: string

Defined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:7

use id instead


readonly createdAt: Date

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-tracked-dates.model.d.ts:5

The date when the record was created.

AspectTypeDTO.createdAt


optional createdBy: string | null

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-audit-meta.model.d.ts:7

The ID of the user who created the resource.

AspectTypeDTO.createdBy


createdByKind: "Group" | "User" | "Unknown" | "API" | "System"

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-audit-meta.model.d.ts:11

The kind of the user who created the resource.

AspectTypeDTO.createdByKind


optional customId: string | null

Defined in: node_modules/@flyze/lib-db-models/models/shared/custom-identifiable.model.d.ts:2

AspectTypeDTO.customId


defaultConfig: Omit<IAspectConfig, "history"> & object

Defined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:15

optional history: object

history configuration is now managed through query parameters

optional aggregations: any

optional isActive: boolean

AspectTypeDTO.defaultConfig


description: string | null

Defined in: node_modules/@flyze/lib-db-models/models/aspect-type/aspect-type.model.d.ts:9

AspectTypeDTO.description


optional displayName: string | null

Defined in: node_modules/@flyze/lib-db-models/models/aspect-type/aspect-type.model.d.ts:15

A user-friendly name for the aspect type.

AspectTypeDTO.displayName


readonly entityKind: "aspect-type"

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-entity-kind.model.d.ts:31

The kind of the entity.

AspectTypeDTO.entityKind


readonly id: string

Defined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:8

AspectTypeDTO.id


optional instanceId: string

Defined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:32


readonly isInSync: boolean

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-migration.model.d.ts:10

Specifies whether the current entity is in sync with the migration state of

migrationId.

AspectTypeDTO.isInSync


readonly migrationId: string | null

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-migration.model.d.ts:6

Stores the migration identifier for this entity.

AspectTypeDTO.migrationId


name: string

Defined in: node_modules/@flyze/lib-db-models/models/aspect-type/aspect-type.model.d.ts:8

The name of the aspect type. Handled like a class name

AspectTypeDTO.name


optional ownerId: string | null

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-owner.model.d.ts:14

The ID of the owner of the resource.

AspectTypeDTO.ownerId


ownerKind: "Group" | "User" | "Unknown" | "API" | "System"

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-owner.model.d.ts:18

The owner of the resource.

AspectTypeDTO.ownerKind


readonly resourcePermission: ResourcePermissions

Defined in: node_modules/@flyze/lib-db-models/models/shared/resource-permissions.model.d.ts:27

Describes the permissions of the user on the resource.

AspectTypeDTO.resourcePermission


structure: AspectTypeStructure

Defined in: node_modules/@flyze/lib-db-models/models/aspect-type/aspect-type.model.d.ts:11

AspectTypeDTO.structure


optional tagIds: string[]

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-tags.model.d.ts:6

Tags IDs this entity is associated with

AspectTypeDTO.tagIds


readonly updatedAt: Date

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-tracked-dates.model.d.ts:9

The date when the record was last updated.

AspectTypeDTO.updatedAt


optional updatedBy: string | null

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-audit-meta.model.d.ts:15

The ID of the user who last updated the resource.

AspectTypeDTO.updatedBy


updatedByKind: "Group" | "User" | "Unknown" | "API" | "System"

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-audit-meta.model.d.ts:19

The kind of the user who last updated the resource.

AspectTypeDTO.updatedByKind