Mastering Date and DateTime Columns in NestJS with TypeORM

In modern web development, handling dates and times is a common requirement, especially when working with databases. NestJS, a progressive Node.js framework, often integrates with TypeORM for object-relational mapping. This article delves into how to effectively create and manage columns with Date and DateTime types in NestJS using TypeORM.

Defining Date and DateTime Columns

To define columns that accept Date or DateTime formats, the @Column decorator from TypeORM is used. Within this decorator, the type option specifies the database column type. For instance, to store a date-only value, you can set type: 'date', and for a timestamp with timezone, type: 'timestamptz' is recommended.

import { Entity, Column } from 'typeorm';

@Entity()
export class ExampleEntity {
    @Column({ type: 'date' })
    dateOnly: string; // Note: type string for date-only columns

    @Column({ type: 'timestamptz' })
    dateTimeWithTimezone: Date; // Recommended for timestamps

    @Column({ type: 'timestamp' })
    dateTimeWithoutTimezone: Date; // Not recommended due to timezone issues
}

In the code above, dateOnly is of type string because TypeORM maps date-only columns to string in JavaScript to avoid timezone complications. For more details, refer to the TypeORM documentation on column types.

Automatic Date Management Columns

TypeORM provides special decorators for automatic date management, which are particularly useful for tracking creation, update, and deletion times. These include @CreateDateColumn, @UpdateDateColumn, and @DeleteDateColumn.

import { Entity, CreateDateColumn, UpdateDateColumn, DeleteDateColumn } from 'typeorm';

@Entity()
export class UserEntity {
    @CreateDateColumn()
    createdAt: Date; // Automatically set on creation

    @UpdateDateColumn()
    updatedAt: Date; // Automatically updated on modification

    @DeleteDateColumn()
    deletedAt: Date; // Set when soft delete is enabled
}

These decorators automatically handle the date values, reducing boilerplate code and ensuring consistency.

Best Practices and Considerations

When working with dates in TypeORM, it's crucial to consider timezone handling. Using timestamptz for timestamps is advised as it includes timezone information, preventing ambiguities. Additionally, for date-only columns, storing them as strings can simplify operations without timezone offsets.

Always refer to the official TypeORM documentation for the most up-to-date information and database-specific details, such as MySQL or PostgreSQL variations.