Interface: AspectType
@flyze/lib-data-store 3.0.0-alpha.55· latestDefined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:3
Extends
Section titled “Extends”AspectTypeDTO
Properties
Section titled “Properties”
optional__v:number
Defined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:13
Deprecated
Section titled “Deprecated”
optional_id:string
Defined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:7
Deprecated
Section titled “Deprecated”use id instead
createdAt
Section titled “createdAt”
readonlycreatedAt: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.
Inherited from
Section titled “Inherited from”AspectTypeDTO.createdAt
createdBy?
Section titled “createdBy?”
optionalcreatedBy: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.
Inherited from
Section titled “Inherited from”AspectTypeDTO.createdBy
createdByKind
Section titled “createdByKind”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.
Inherited from
Section titled “Inherited from”AspectTypeDTO.createdByKind
customId?
Section titled “customId?”
optionalcustomId:string|null
Defined in: node_modules/@flyze/lib-db-models/models/shared/custom-identifiable.model.d.ts:2
Inherited from
Section titled “Inherited from”AspectTypeDTO.customId
defaultConfig
Section titled “defaultConfig”defaultConfig:
Omit<IAspectConfig,"history"> &object
Defined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:15
Type Declaration
Section titled “Type Declaration”history?
Section titled “history?”
optionalhistory:object
Deprecated
Section titled “Deprecated”history configuration is now managed through query parameters
history.aggregations?
Section titled “history.aggregations?”
optionalaggregations:any
Deprecated
Section titled “Deprecated”history.isActive?
Section titled “history.isActive?”
optionalisActive:boolean
Deprecated
Section titled “Deprecated”Overrides
Section titled “Overrides”AspectTypeDTO.defaultConfig
description
Section titled “description”description:
string|null
Defined in: node_modules/@flyze/lib-db-models/models/aspect-type/aspect-type.model.d.ts:9
Inherited from
Section titled “Inherited from”AspectTypeDTO.description
displayName?
Section titled “displayName?”
optionaldisplayName: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.
Inherited from
Section titled “Inherited from”AspectTypeDTO.displayName
entityKind
Section titled “entityKind”
readonlyentityKind:"aspect-type"
Defined in: node_modules/@flyze/lib-db-models/models/shared/has-entity-kind.model.d.ts:31
The kind of the entity.
Inherited from
Section titled “Inherited from”AspectTypeDTO.entityKind
readonlyid:string
Defined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:8
Overrides
Section titled “Overrides”AspectTypeDTO.id
instanceId?
Section titled “instanceId?”
optionalinstanceId:string
Defined in: projects/lib-data-store/src/lib/flyze-models/aspect-type.model.ts:32
isInSync
Section titled “isInSync”
readonlyisInSync: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.
Inherited from
Section titled “Inherited from”AspectTypeDTO.isInSync
migrationId
Section titled “migrationId”
readonlymigrationId: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.
Inherited from
Section titled “Inherited from”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
Inherited from
Section titled “Inherited from”AspectTypeDTO.name
ownerId?
Section titled “ownerId?”
optionalownerId: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.
Inherited from
Section titled “Inherited from”AspectTypeDTO.ownerId
ownerKind
Section titled “ownerKind”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.
Inherited from
Section titled “Inherited from”AspectTypeDTO.ownerKind
resourcePermission
Section titled “resourcePermission”
readonlyresourcePermission: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.
Inherited from
Section titled “Inherited from”AspectTypeDTO.resourcePermission
structure
Section titled “structure”structure:
AspectTypeStructure
Defined in: node_modules/@flyze/lib-db-models/models/aspect-type/aspect-type.model.d.ts:11
Inherited from
Section titled “Inherited from”AspectTypeDTO.structure
tagIds?
Section titled “tagIds?”
optionaltagIds:string[]
Defined in: node_modules/@flyze/lib-db-models/models/shared/has-tags.model.d.ts:6
Tags IDs this entity is associated with
Inherited from
Section titled “Inherited from”AspectTypeDTO.tagIds
updatedAt
Section titled “updatedAt”
readonlyupdatedAt: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.
Inherited from
Section titled “Inherited from”AspectTypeDTO.updatedAt
updatedBy?
Section titled “updatedBy?”
optionalupdatedBy: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.
Inherited from
Section titled “Inherited from”AspectTypeDTO.updatedBy
updatedByKind
Section titled “updatedByKind”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.
Inherited from
Section titled “Inherited from”AspectTypeDTO.updatedByKind