Class TypeOrmUtilities`Abstract`

Utilities for dealing with typeorm.

Index

Constructors

Methods

getColumnMetadata getEntityMetadata normalizeColumnType

Constructors

constructor

new TypeOrmUtilities(): TypeOrmUtilities
Returns TypeOrmUtilities

Methods

`Static`getColumnMetadata

getColumnMetadata<T extends BaseEntity>(
    target: EntityTarget<T>,
    propertyName: string & {} | keyof T,
    transaction: Transaction,
): ColumnMetadata
Gets the metadata for a typeorm column.
Type Parameters
- T extends BaseEntity
Parameters
- target: EntityTarget<T>
  The entity.
- propertyName: string & {} | keyof T
  The name of the property to get the column metadata for.
- transaction: Transaction
  The transaction to use to get the column metadata.
Returns ColumnMetadata
The typeorm column metadata.

Throws
When the provided propertyName could not be found as a column.
- Defined in src/utilities/typeorm.utilities.ts:20

`Static`getEntityMetadata

getEntityMetadata<T extends BaseEntity>(
target: EntityTarget<T>,
transaction: Transaction,
): EntityMetadata
Gets the typeorm metadata for a given entity.
Type Parameters
- T extends BaseEntity
Parameters
- target: EntityTarget<T>
  The target entity.
- transaction: Transaction
  The transaction to run this command with.
Returns EntityMetadata
The typeorm metadata.
- Defined in src/utilities/typeorm.utilities.ts:45

`Static`normalizeColumnType

normalizeColumnType(
    dataSource: DataSource | undefined,
    column: {
        isArray?: boolean;
        length?: string | number;
        precision?: number | null;
        scale?: number;
        type?: string & {} | ColumnType;
    },
): string
Normalizes the type of the given column using the provided dataSource.
Parameters
- dataSource: DataSource | undefined
- column: {
      isArray?: boolean;
      length?: string | number;
      precision?: number | null;
      scale?: number;
      type?: string & {} | ColumnType;
  }
Returns string
The normalized column type as a string.

Throws
When no dataSource has been provided.
- Defined in src/utilities/typeorm.utilities.ts:55