Skip to main content
Version: Next

MetadataError <T>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • message: string
    • optionalentity: T

    Returns MetadataError<T>

Properties

optionalinheritedcause

cause?: unknown

optionalreadonlyinheritedentity

entity?: T

inheritedmessage

message: string

inheritedname

name: string

optionalinheritedstack

stack?: string

staticinheritedstackTraceLimit

stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Methods

inheritedgetEntity

  • getEntity(): undefined | Partial<any>

  • Gets instance of entity that caused this error.

    Returns undefined | Partial<any>

staticinheritedcannotCommit

  • Returns ValidationError<Partial<any>>

staticinheritedcannotModifyInverseCollection

  • Parameters

    Returns ValidationError<Partial<any>>

staticinheritedcannotModifyReadonlyCollection

  • Parameters

    Returns ValidationError<Partial<any>>

staticinheritedcannotRemoveFromCollectionWithoutOrphanRemoval

  • Parameters

    Returns ValidationError<Partial<any>>

staticinheritedcannotUseGlobalContext

  • Returns ValidationError<Partial<any>>

staticinheritedcannotUseOperatorsInsideEmbeddables

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

  • Parameters

    • className: string
    • propName: string
    • payload: unknown

    Returns ValidationError<Partial<any>>

staticinheritedcaptureStackTrace

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

  • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

    const myObject = {};
    Error.captureStackTrace(myObject);
    myObject.stack;  // Similar to `new Error().stack`

    The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

    The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

    The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

    function a() {
      b();
    }

    function b() {
      c();
    }

    function c() {
      // Create an error without stack trace to avoid calculating the stack trace twice.
      const { stackTraceLimit } = Error;
      Error.stackTraceLimit = 0;
      const error = new Error();
      Error.stackTraceLimit = stackTraceLimit;

      // Capture the stack trace above function b
      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
      throw error;
    }

    a();

    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

  • Parameters

    • entity: Partial<any>

    Returns ValidationError<Partial<any>>

staticinheritedfromCollectionNotInitialized

  • Parameters

    Returns ValidationError<Partial<any>>

staticfromInversideSidePrimary

staticinheritedfromMergeWithoutPK

staticfromMissingOption

staticfromMissingPrimaryKey

staticfromUnknownEntity

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

  • Parameters

    • className: string
    • source: string

    Returns MetadataError<Partial<any>>

staticfromWrongForeignKey

staticfromWrongOwnership

staticinheritedfromWrongPropertyType

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

  • Parameters

    • entity: Partial<any>
    • property: string
    • expectedType: string
    • givenType: string
    • givenValue: string

    Returns ValidationError<Partial<any>>

staticfromWrongReference

staticfromWrongReferenceKind

staticinheritedfromWrongRepositoryType

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

  • Parameters

    • entityName: string
    • repoType: string
    • method: string

    Returns ValidationError<Partial<any>>

staticfromWrongTypeDefinition

staticinheritedinvalidCompositeIdentifier

staticinheritedinvalidEmbeddableQuery

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

  • Parameters

    • className: string
    • propName: string
    • embeddableType: string

    Returns ValidationError<Partial<any>>

staticinvalidManyToManyWithPivotEntity

staticinvalidPrimaryKey

staticinheritedinvalidPropertyName

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

  • Parameters

    • entityName: string
    • invalid: string

    Returns ValidationError<Partial<any>>

staticinheritedinvalidType

  • Parameters

    Returns ValidationError<Partial<any>>

staticinvalidVersionFieldType

staticmissingMetadata

staticmultipleDecorators

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

  • Parameters

    • entityName: string
    • propertyName: string

    Returns MetadataError<Partial<any>>

staticmultipleVersionFields

staticnoEntityDiscovered

staticnonPersistentCompositeProp

staticinheritednotDiscoveredEntity

  • Parameters

    Returns ValidationError<Partial<any>>

staticinheritednotEntity

  • Parameters

    Returns ValidationError<Partial<any>>

staticonlyAbstractEntitiesDiscovered

staticinheritedprepareStackTrace

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

staticinheritedpropertyRequired

  • Parameters

    Returns ValidationError<Partial<any>>

staticpropertyTargetsEntityType

statictargetIsAbstract

staticinheritedtransactionRequired

  • Returns ValidationError<Partial<any>>

staticunknownIndexProperty

Page Options