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
• fromWrongOwnership
• fromWrongPropertyType
• fromWrongReference
• fromWrongReferenceKind
• fromWrongRepositoryType
• fromWrongTypeDefinition
• invalidCompositeIdentifier
• invalidEmbeddableQuery
• invalidManyToManyWithPivotEntity
• invalidPrimaryKey
• invalidPropertyName
• invalidType
• invalidVersionFieldType
• missingMetadata
• multipleDecorators
• multipleVersionFields
• noEntityDiscovered
• notDiscoveredEntity
• notEntity
• onlyAbstractEntitiesDiscovered
• propertyRequired
• propertyTargetsEntityType
• targetIsAbstract
• transactionRequired
• unknownIndexProperty

Constructors

constructor

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

• Inherited from ValidationError.constructor

  Type parameters

  • T: Partial<any> = Partial<any>

  Parameters

  • message: string

  • optionalentity: T

  Returns MetadataError<T>

Properties

optionalcause

cause?: unknown

Inherited from ValidationError.cause

optionalreadonlyentity

entity?: T

Inherited from ValidationError.entity

message

message: string

Inherited from ValidationError.message

name

name: string

Inherited from ValidationError.name

optionalstack

stack?: string

Inherited from ValidationError.stack

staticoptionalprepareStackTrace

prepareStackTrace?: (err, stackTraces) => 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, stackTraces): any

  • Parameters

    • err: Error

    • stackTraces: CallSite[]

    Returns any

staticstackTraceLimit

stackTraceLimit: number

Inherited from ValidationError.stackTraceLimit

Methods

getEntity

• getEntity(): undefined | Partial<any>

• Inherited from ValidationError.getEntity

  Gets instance of entity that caused this error.

  ---

  Returns undefined | Partial<any>

staticcannotCommit

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

• Inherited from ValidationError.cannotCommit

  Returns ValidationError<Partial<any>>

staticcannotModifyInverseCollection

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

• Inherited from ValidationError.cannotModifyInverseCollection

  Parameters

  • owner: Partial<any>

  • property: EntityProperty<any, any>

  Returns ValidationError<Partial<any>>

staticcannotModifyReadonlyCollection

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

• Inherited from ValidationError.cannotModifyReadonlyCollection

  Parameters

  • owner: Partial<any>

  • property: EntityProperty<any, any>

  Returns ValidationError<Partial<any>>

staticcannotRemoveFromCollectionWithoutOrphanRemoval

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

• Inherited from ValidationError.cannotRemoveFromCollectionWithoutOrphanRemoval

  Parameters

  • owner: Partial<any>

  • property: EntityProperty<any, any>

  Returns ValidationError<Partial<any>>

staticcannotUseGlobalContext

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

• Inherited from ValidationError.cannotUseGlobalContext

  Returns ValidationError<Partial<any>>

staticcannotUseOperatorsInsideEmbeddables

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

• Inherited from ValidationError.cannotUseOperatorsInsideEmbeddables

  Parameters

  • className: string

  • propName: string

  • payload: unknown

  Returns ValidationError<Partial<any>>

staticcaptureStackTrace

• captureStackTrace(targetObject, constructorOpt): void

• Inherited from ValidationError.captureStackTrace

  Create .stack property on a target object

  ---

  Parameters

  • targetObject: object

  • optionalconstructorOpt: Function

  Returns void

staticduplicateEntityDiscovered

• duplicateEntityDiscovered(paths, subject): MetadataError<Partial<any>>

• Parameters

  • paths: string[]

  • subject: string = 'entity names'

  Returns MetadataError<Partial<any>>

staticduplicateFieldName

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

• Parameters

  • className: string

  • names: [string, string][]

  Returns MetadataError<Partial<any>>

staticentityNotFound

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

• Parameters

  • name: string

  • path: string

  Returns MetadataError<Partial<any>>

staticentityNotManaged

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

• Inherited from ValidationError.entityNotManaged

  Parameters

  • entity: Partial<any>

  Returns ValidationError<Partial<any>>

staticfromCollectionNotInitialized

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

• Inherited from ValidationError.fromCollectionNotInitialized

  Parameters

  • entity: Partial<any>

  • prop: EntityProperty<any, any>

  Returns ValidationError<Partial<any>>

staticfromInversideSidePrimary

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

• Parameters

  • meta: EntityMetadata<any>

  • owner: EntityProperty<any, any>

  • prop: EntityProperty<any, any>

  Returns MetadataError<Partial<any>>

staticfromMergeWithoutPK

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

• Inherited from ValidationError.fromMergeWithoutPK

  Parameters

  • meta: EntityMetadata<any>

  Returns ValidationError<Partial<any>>

staticfromMissingOption

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

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  • option: string

  Returns MetadataError<Partial<any>>

staticfromMissingPrimaryKey

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

• Parameters

  • meta: EntityMetadata<any>

  Returns MetadataError<Partial<any>>

staticfromUnknownEntity

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

• Parameters

  • className: string

  • source: string

  Returns MetadataError<Partial<any>>

staticfromWrongOwnership

• fromWrongOwnership(meta, prop, key): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  • key: inversedBy | mappedBy

  Returns MetadataError<Partial<any>>

staticfromWrongPropertyType

• fromWrongPropertyType(entity, property, expectedType, givenType, givenValue): 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, prop, key, owner): 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, owner, prop): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • owner: EntityProperty<any, any>

  • prop: EntityProperty<any, any>

  Returns MetadataError<Partial<any>>

staticfromWrongRepositoryType

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

• Inherited from ValidationError.fromWrongRepositoryType

  Parameters

  • entityName: string

  • repoType: string

  • method: string

  Returns ValidationError<Partial<any>>

staticfromWrongTypeDefinition

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

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  Returns MetadataError<Partial<any>>

staticinvalidCompositeIdentifier

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

• Inherited from ValidationError.invalidCompositeIdentifier

  Parameters

  • meta: EntityMetadata<any>

  Returns ValidationError<Partial<any>>

staticinvalidEmbeddableQuery

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

• Inherited from ValidationError.invalidEmbeddableQuery

  Parameters

  • className: string

  • propName: string

  • embeddableType: string

  Returns ValidationError<Partial<any>>

staticinvalidManyToManyWithPivotEntity

• invalidManyToManyWithPivotEntity(meta1, prop1, meta2, prop2): 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, prop, requiredName): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  • requiredName: string

  Returns MetadataError<Partial<any>>

staticinvalidPropertyName

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

• Inherited from ValidationError.invalidPropertyName

  Parameters

  • entityName: string

  • invalid: string

  Returns ValidationError<Partial<any>>

staticinvalidType

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

• Inherited from ValidationError.invalidType

  Parameters

  • type: Constructor<any>

  • value: any

  • mode: string

  Returns ValidationError<Partial<any>>

staticinvalidVersionFieldType

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

• Parameters

  • meta: EntityMetadata<any>

  Returns MetadataError<Partial<any>>

staticmissingMetadata

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

• Parameters

  • entity: string

  Returns MetadataError<Partial<any>>

staticmultipleDecorators

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

• Parameters

  • entityName: string

  • propertyName: string

  Returns MetadataError<Partial<any>>

staticmultipleVersionFields

• multipleVersionFields(meta, fields): MetadataError<Partial<any>>

• Parameters

  • meta: EntityMetadata<any>

  • fields: string[]

  Returns MetadataError<Partial<any>>

staticnoEntityDiscovered

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

• Returns MetadataError<Partial<any>>

staticnotDiscoveredEntity

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

• Inherited from ValidationError.notDiscoveredEntity

  Parameters

  • data: any

  • optionalmeta: EntityMetadata<any>

  • action: string = 'persist'

  Returns ValidationError<Partial<any>>

staticnotEntity

• notEntity(owner, prop, data): 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>>

staticpropertyRequired

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

• Inherited from ValidationError.propertyRequired

  Parameters

  • entity: Partial<any>

  • property: EntityProperty<any, any>

  Returns ValidationError<Partial<any>>

staticpropertyTargetsEntityType

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

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  • target: EntityMetadata<any>

  Returns MetadataError<Partial<any>>

statictargetIsAbstract

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

• Parameters

  • meta: EntityMetadata<any>

  • prop: EntityProperty<any, any>

  Returns MetadataError<Partial<any>>

statictransactionRequired

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

• Inherited from ValidationError.transactionRequired

  Returns ValidationError<Partial<any>>

staticunknownIndexProperty

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

• Parameters

  • meta: EntityMetadata<any>

  • prop: string

  • type: string

  Returns MetadataError<Partial<any>>