The serverTimeStamp() function in firebase.firestore.FieldValue does not allow for the Timestamp data type to be used

Question

The serverTimeStamp() function in firebase.firestore.FieldValue does not allow for the Timestamp data type to be used

 async addNewUser(id: string, email: string) {
    await this.afs.doc<MemberProfileModel>(FirestoreDbConstant.MEMBER_PROFILES + `/${id}`).set({
      email,
      registeredDate: firebase.firestore.FieldValue.serverTimestamp(),
    });
  }

This approach is functioning well.

export interface MemberProfileModel {
    email: string;
    registeredDate?: firebase.firestore.FieldValue;
}

However, why am I encountering issues when trying to use Timestamp as follows?

import { Timestamp } from '@firebase/firestore-types';

export interface MemberProfileModel {
    email: string;
    registeredDate?: Timestamp;
}

The above code snippet results in the following error message:

(property) MemberProfileModel.registeredDate?: Timestamp Type 'FieldValue' is missing properties such as seconds, nanoseconds, toDate, toMillists(2739) user-profile.model.ts(11, 5): The expected type is derived from property 'registeredDate' declared in type 'MemberProfileModel'

The main issue here is that I need to utilize toDate() in the template, which does not work with

registeredDate?: firebase.firestore.FieldValue;

<p>{{memberEvent.joiningDatetime.toDate() | amDateFormat: 'MMM DD'}}</p>

angular typescript firebase google-cloud-firestore

Answer 1

Answer №1

In the documentation for serverTimestamp() in the JavaScript API, it is explained:

serverTimestamp(): FieldValue

This method returns a special sentinel value that can be used with set() or update() to include a timestamp generated by the server in the data being written.

Returns FieldValue

It's important to note that serverTimestamp() does not return a Timestamp type, but rather a placeholder FieldValue. This tells the server to generate the timestamp as opposed to relying on the client device's clock, which may be unreliable.

When working with records that use server timestamps, you will encounter a difference in representation between writing and reading. Upon insertion, the value will be a FieldValue, but when retrieving the document, it will appear as a Timestamp.

Answer 2

In the documentation for serverTimestamp() in the JavaScript API, it is explained:

serverTimestamp(): FieldValue

This method returns a special sentinel value that can be used with set() or update() to include a timestamp generated by the server in the data being written.

Returns FieldValue

It's important to note that serverTimestamp() does not return a Timestamp type, but rather a placeholder FieldValue. This tells the server to generate the timestamp as opposed to relying on the client device's clock, which may be unreliable.

When working with records that use server timestamps, you will encounter a difference in representation between writing and reading. Upon insertion, the value will be a FieldValue, but when retrieving the document, it will appear as a Timestamp.

Answer 3

Answer №2

Consider this alternative approach rather than simply copying models:

lastUpdated: Timestamp | FieldValue;

Answer 4

Consider this alternative approach rather than simply copying models:

lastUpdated: Timestamp | FieldValue;

Answer 5

Answer №3

If you're looking for an alternative approach, consider creating your own custom interface that combines elements of both Timestamp and FieldValue.

    export interface CustomTimestamp extends Partial<FieldValue>, Partial<Timestamp>
    {
      isEqual: (other: any) => boolean;
      valueOf: () => any;
    }

By defining this interface, you can then assign the timestamp properties in the following way:

    export interface UserProfileModel {
        email: string;
        createdDate?: CustomTimestamp;
    }

This method will provide you with appropriate types for interacting with Firestore data seamlessly.

It's important to note that with this setup, all properties and methods become optional. For instance, if you want to use toDate() on a Timestamp object, you'll need to handle it like so: user.createdDate?.toDate?.()

For writing data:

user.createdDate = FieldValue.serverTimestamp();

For reading data:

user.createdDate?.toDate?.();

Answer 6

If you're looking for an alternative approach, consider creating your own custom interface that combines elements of both Timestamp and FieldValue.

    export interface CustomTimestamp extends Partial<FieldValue>, Partial<Timestamp>
    {
      isEqual: (other: any) => boolean;
      valueOf: () => any;
    }

By defining this interface, you can then assign the timestamp properties in the following way:

    export interface UserProfileModel {
        email: string;
        createdDate?: CustomTimestamp;
    }

This method will provide you with appropriate types for interacting with Firestore data seamlessly.

It's important to note that with this setup, all properties and methods become optional. For instance, if you want to use toDate() on a Timestamp object, you'll need to handle it like so: user.createdDate?.toDate?.()

For writing data:

user.createdDate = FieldValue.serverTimestamp();

For reading data:

user.createdDate?.toDate?.();

The serverTimeStamp() function in firebase.firestore.FieldValue does not allow for the Timestamp data type to be used

Answer №1

Answer №2

Answer №3

Similar questions

Troubleshooting: Issue with Angular 2 bidirectional data binding on two input fields

Managing JSON object with irregular data in Angular 7: Best Practices

Efficiently Combining Objects with Rxjs

Troubleshooting Angular 4 Routing Problems

strictBindCallApply causing issues when working with generic parameters

Struggling with verifying the visibility of multiple elements using the toBeVisible() assertion

When a React component in TypeScript is passed as a parameter and then assigned to a variable, an error with code TS2604 may occur stating that the JSX element type does not

Encountering difficulties importing in Typescript and ts-node node scripts, regardless of configuration or package type

What are some ways to use SWR for mutating data specific to a certain ID?

Condition not applying in the Modal

Establish HTTP headers for accessing the Oxford API in an Angular 6 application

Different ways to showcase an image from a library in Ionic 3

Removing HTML Tags in Ionic - A How-To Guide

Is it possible for me to change a selector value?

Plugin for managing network connectivity in Ionic framework

Edge Runtime does not permit the use of Dynamic Code Evaluation functions such as 'eval', 'new Function', and 'WebAssembly.compile'

Validation of Date in Angular 5 (with specified minimum and maximum dates)

ArrangementGrid utilizing ngFor directive for rows and columns

Reducing file size when uploading images in Angular4 through image compression

Explain a category of instance used in a template parameter