MetadataError <T>

Hierarchy

• ValidationError<T>
  • MetadataError

Index

Constructors

• constructor

Properties

• cause
• entity
• message
• name
• stack
• prepareStackTrace
• stackTraceLimit

Methods

• getEntity
• cannotCommit
• cannotModifyInverseCollection
• cannotModifyReadonlyCollection
• cannotRemoveFromCollectionWithoutOrphanRemoval
• cannotUseGlobalContext
• cannotUseOperatorsInsideEmbeddables
• captureStackTrace
• duplicateEntityDiscovered
• duplicateFieldName
• entityNotFound
• entityNotManaged
• fromCollectionNotInitialized
• fromInversideSidePrimary
• fromMergeWithoutPK
• fromMissingOption
• fromMissingPrimaryKey
• fromUnknownEntity
• fromWrongForeignKey
• fromWrongOwnership
• fromWrongPropertyType
• fromWrongReference
• fromWrongReferenceKind
• fromWrongRepositoryType
• fromWrongTypeDefinition
• invalidCompositeIdentifier
• invalidEmbeddableQuery
• invalidManyToManyWithPivotEntity
• invalidPrimaryKey
• invalidPropertyName
• invalidType
• invalidVersionFieldType
• missingMetadata
• multipleDecorators
• multipleVersionFields
• noEntityDiscovered
• nonPersistentCompositeProp
• notDiscoveredEntity
• notEntity
• onlyAbstractEntitiesDiscovered
• propertyRequired
• propertyTargetsEntityType
• targetIsAbstract
• transactionRequired
• unknownIndexProperty

Constructors

constructor

• new MetadataError(message: string, entity?: T): MetadataError<T>

• Inherited from ValidationError.constructor

  Parameters

  • message: string

  • optionalentity: T

  Returns MetadataError<T>

Properties

optionalinheritedcause

cause?: unknown

Inherited from ValidationError.cause

optionalreadonlyinheritedentity

entity?: T

Inherited from ValidationError.entity

inheritedmessage

message: string

Inherited from ValidationError.message

inheritedname

name: string

Inherited from ValidationError.name

optionalinheritedstack

stack?: string

Inherited from ValidationError.stack

staticoptionalinheritedprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Inherited from ValidationError.prepareStackTrace

Optional override for formatting stack traces

@see

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

---

Type declaration

• • (err: Error, stackTraces: CallSite[]): any

  • Parameters

    • err: Error

    • stackTraces: CallSite[]

    Returns any

staticinheritedstackTraceLimit

stackTraceLimit: number

Inherited from ValidationError.stackTraceLimit

Methods

inheritedgetEntity

• getEntity(): undefined | Partial<any>

• Inherited from ValidationError.getEntity

  Gets instance of entity that caused this error.

  ---

  Returns undefined | Partial<any>

staticinheritedcannotCommit

• cannotCommit(): ValidationError<Partial<any>>

• Inherited from ValidationError.cannotCommit

  Returns ValidationError<Partial<any>>

staticinheritedcannotModifyInverseCollection

• cannotModifyInverseCollection(owner: Partial<any>, property: EntityProperty<any, any>): ValidationError<Partial<any>>

• Inherited from ValidationError.cannotModifyInverseCollection

  Parameters

  • owner: Partial<any>

  • property: EntityProperty<any, any>

  Returns ValidationError<Partial<any>>

staticinheritedcannotModifyReadonlyCollection

• cannotModifyReadonlyCollection(owner: Partial<any>, property: EntityProperty<any, any>): ValidationError<Partial<any>>

• Inherited from ValidationError.cannotModifyReadonlyCollection

  Parameters

  • owner: Partial<any>

  • property: EntityProperty<any, any>

  Returns ValidationError<Partial<any>>

staticinheritedcannotRemoveFromCollectionWithoutOrphanRemoval

• cannotRemoveFromCollectionWithoutOrphanRemoval(owner: Partial<any>, property: EntityProperty<any, any>): ValidationError<Partial<any>>

• Inherited from ValidationError.cannotRemoveFromCollectionWithoutOrphanRemoval

  Parameters

  • owner: Partial<any>

  • property: EntityProperty<any, any>

  Returns ValidationError<Partial<any>>

staticinheritedcannotUseGlobalContext

• cannotUseGlobalContext(): ValidationError<Partial<any>>

• Inherited from ValidationError.cannotUseGlobalContext

  Returns ValidationError<Partial<any>>

staticinheritedcannotUseOperatorsInsideEmbeddables

• cannotUseOperatorsInsideEmbeddables(className: string, propName: string, payload: unknown): ValidationError<Partial<any>>

• Inherited from ValidationError.cannotUseOperatorsInsideEmbeddables

  Parameters

  • className: string

  • propName: string

  • payload: unknown

  Returns ValidationError<Partial<any>>

staticinheritedcaptureStackTrace

• captureStackTrace(targetObject: object, constructorOpt?: Function): void

• Inherited from ValidationError.captureStackTrace

  Create .stack property on a target object

  ---

  Parameters

  • targetObject: object

  • optionalconstructorOpt: Function

  Returns void

staticduplicateEntityDiscovered

• duplicateEntityDiscovered(paths: string[], subject?: string): MetadataError<Partial<any>>

• Parameters

  • paths: string[]

  • subject: string = 'entity names'

  Returns MetadataError<Partial<any>>

staticduplicateFieldName

• duplicateFieldName(className: string, names: [string, string][]): MetadataError<Partial<any>>

• Parameters

  • className: string

  • names: [string, string][]

  Returns MetadataError<Partial<any>>

staticentityNotFound

• entityNotFound(name: string, path: string): MetadataError<Partial<any>>

• Parameters

  • name: string

  • path: string

  Returns MetadataError<Partial<any>>

staticinheritedentityNotManaged

• entityNotManaged(entity: Partial<any>): ValidationError<Partial<any>>

• Inherited from ValidationError.entityNotManaged

  Parameters

  • entity: Partial<any>

  Returns ValidationError<Partial<any>>

staticinheritedfromCollectionNotInitialized

• fromCollectionNotInitialized(entity: Partial<any>, prop: EntityProperty<any, any>): ValidationError<Partial<any>>

• Inherited from ValidationError.fromCollectionNotInitialized

  Parameters

  • entity: Partial<any>

  • prop: EntityProperty<any, any>

  Returns ValidationError<Partial<any>>

staticfromInversideSidePrimary

• fromInversideSidePrimary(meta: EntityMetadata<any>, owner: EntityProperty<any, any>, prop: EntityProperty<any, any>): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • owner: EntityProperty<any, any>

  • prop: EntityProperty<any, any>

  Returns MetadataError<Partial<any>>

staticinheritedfromMergeWithoutPK

• fromMergeWithoutPK(meta: EntityMetadata<any>): ValidationError<Partial<any>>

• Inherited from ValidationError.fromMergeWithoutPK

  Parameters

  • meta: EntityMetadata<any>

  Returns ValidationError<Partial<any>>

staticfromMissingOption

• fromMissingOption(meta: EntityMetadata<any>, prop: EntityProperty<any, any>, option: string): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  • option: string

  Returns MetadataError<Partial<any>>

staticfromMissingPrimaryKey

• fromMissingPrimaryKey(meta: EntityMetadata<any>): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  Returns MetadataError<Partial<any>>

staticfromUnknownEntity

• fromUnknownEntity(className: string, source: string): MetadataError<Partial<any>>

• Parameters

  • className: string

  • source: string

  Returns MetadataError<Partial<any>>

staticfromWrongForeignKey

• fromWrongForeignKey(meta: EntityMetadata<any>, prop: EntityProperty<any, any>, key: string): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  • key: string

  Returns MetadataError<Partial<any>>

staticfromWrongOwnership

• fromWrongOwnership(meta: EntityMetadata<any>, prop: EntityProperty<any, any>, key: inversedBy | mappedBy): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  • key: inversedBy | mappedBy

  Returns MetadataError<Partial<any>>

staticinheritedfromWrongPropertyType

• fromWrongPropertyType(entity: Partial<any>, property: string, expectedType: string, givenType: string, givenValue: string): ValidationError<Partial<any>>

• Inherited from ValidationError.fromWrongPropertyType

  Parameters

  • entity: Partial<any>

  • property: string

  • expectedType: string

  • givenType: string

  • givenValue: string

  Returns ValidationError<Partial<any>>

staticfromWrongReference

• fromWrongReference(meta: EntityMetadata<any>, prop: EntityProperty<any, any>, key: inversedBy | mappedBy, owner?: EntityProperty<any, any>): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  • key: inversedBy | mappedBy

  • optionalowner: EntityProperty<any, any>

  Returns MetadataError<Partial<any>>

staticfromWrongReferenceKind

• fromWrongReferenceKind(meta: EntityMetadata<any>, owner: EntityProperty<any, any>, prop: EntityProperty<any, any>): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • owner: EntityProperty<any, any>

  • prop: EntityProperty<any, any>

  Returns MetadataError<Partial<any>>

staticinheritedfromWrongRepositoryType

• fromWrongRepositoryType(entityName: string, repoType: string, method: string): ValidationError<Partial<any>>

• Inherited from ValidationError.fromWrongRepositoryType

  Parameters

  • entityName: string

  • repoType: string

  • method: string

  Returns ValidationError<Partial<any>>

staticfromWrongTypeDefinition

• fromWrongTypeDefinition(meta: EntityMetadata<any>, prop: EntityProperty<any, any>): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  Returns MetadataError<Partial<any>>

staticinheritedinvalidCompositeIdentifier

• invalidCompositeIdentifier(meta: EntityMetadata<any>): ValidationError<Partial<any>>

• Inherited from ValidationError.invalidCompositeIdentifier

  Parameters

  • meta: EntityMetadata<any>

  Returns ValidationError<Partial<any>>

staticinheritedinvalidEmbeddableQuery

• invalidEmbeddableQuery(className: string, propName: string, embeddableType: string): ValidationError<Partial<any>>

• Inherited from ValidationError.invalidEmbeddableQuery

  Parameters

  • className: string

  • propName: string

  • embeddableType: string

  Returns ValidationError<Partial<any>>

staticinvalidManyToManyWithPivotEntity

• invalidManyToManyWithPivotEntity(meta1: EntityMetadata<any>, prop1: EntityProperty<any, any>, meta2: EntityMetadata<any>, prop2: EntityProperty<any, any>): MetadataError<Partial<any>>

• Parameters

  • meta1: EntityMetadata<any>

  • prop1: EntityProperty<any, any>

  • meta2: EntityMetadata<any>

  • prop2: EntityProperty<any, any>

  Returns MetadataError<Partial<any>>

staticinvalidPrimaryKey

• invalidPrimaryKey(meta: EntityMetadata<any>, prop: EntityProperty<any, any>, requiredName: string): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  • requiredName: string

  Returns MetadataError<Partial<any>>

staticinheritedinvalidPropertyName

• invalidPropertyName(entityName: string, invalid: string): ValidationError<Partial<any>>

• Inherited from ValidationError.invalidPropertyName

  Parameters

  • entityName: string

  • invalid: string

  Returns ValidationError<Partial<any>>

staticinheritedinvalidType

• invalidType(type: Constructor<any>, value: any, mode: string): ValidationError<Partial<any>>

• Inherited from ValidationError.invalidType

  Parameters

  • type: Constructor<any>

  • value: any

  • mode: string

  Returns ValidationError<Partial<any>>

staticinvalidVersionFieldType

• invalidVersionFieldType(meta: EntityMetadata<any>): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  Returns MetadataError<Partial<any>>

staticmissingMetadata

• missingMetadata(entity: string): MetadataError<Partial<any>>

• Parameters

  • entity: string

  Returns MetadataError<Partial<any>>

staticmultipleDecorators

• multipleDecorators(entityName: string, propertyName: string): MetadataError<Partial<any>>

• Parameters

  • entityName: string

  • propertyName: string

  Returns MetadataError<Partial<any>>

staticmultipleVersionFields

• multipleVersionFields(meta: EntityMetadata<any>, fields: string[]): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • fields: string[]

  Returns MetadataError<Partial<any>>

staticnoEntityDiscovered

• noEntityDiscovered(): MetadataError<Partial<any>>

• Returns MetadataError<Partial<any>>

staticnonPersistentCompositeProp

• nonPersistentCompositeProp(meta: EntityMetadata<any>, prop: EntityProperty<any, any>): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  Returns MetadataError<Partial<any>>

staticinheritednotDiscoveredEntity

• notDiscoveredEntity(data: any, meta?: EntityMetadata<any>, action?: string): ValidationError<Partial<any>>

• Inherited from ValidationError.notDiscoveredEntity

  Parameters

  • data: any

  • optionalmeta: EntityMetadata<any>

  • action: string = 'persist'

  Returns ValidationError<Partial<any>>

staticinheritednotEntity

• notEntity(owner: Partial<any>, prop: EntityProperty<any, any>, data: any): ValidationError<Partial<any>>

• Inherited from ValidationError.notEntity

  Parameters

  • owner: Partial<any>

  • prop: EntityProperty<any, any>

  • data: any

  Returns ValidationError<Partial<any>>

staticonlyAbstractEntitiesDiscovered

• onlyAbstractEntitiesDiscovered(): MetadataError<Partial<any>>

• Returns MetadataError<Partial<any>>

staticinheritedpropertyRequired

• propertyRequired(entity: Partial<any>, property: EntityProperty<any, any>): ValidationError<Partial<any>>

• Inherited from ValidationError.propertyRequired

  Parameters

  • entity: Partial<any>

  • property: EntityProperty<any, any>

  Returns ValidationError<Partial<any>>

staticpropertyTargetsEntityType

• propertyTargetsEntityType(meta: EntityMetadata<any>, prop: EntityProperty<any, any>, target: EntityMetadata<any>): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  • target: EntityMetadata<any>

  Returns MetadataError<Partial<any>>

statictargetIsAbstract

• targetIsAbstract(meta: EntityMetadata<any>, prop: EntityProperty<any, any>): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  Returns MetadataError<Partial<any>>

staticinheritedtransactionRequired

• transactionRequired(): ValidationError<Partial<any>>

• Inherited from ValidationError.transactionRequired

  Returns ValidationError<Partial<any>>

staticunknownIndexProperty

• unknownIndexProperty(meta: EntityMetadata<any>, prop: string, type: string): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: string

  • type: string

  Returns MetadataError<Partial<any>>