Firestore Document Typescript doc.data() undefined?

Question

Currently cleaning up a bit of code and rewritting a lot in typescript. What I found what made me curious is the following code:

    const userRef = firestore.collection('users').doc(userId);
    const userDoc = await userRef.get();

    if (userDoc.exists) {
        const userData = userDoc.data();

        const currentUserBalance = userData.balance ? userData.balance : 0;
    }

Now Typescript will complain that userData is possibily undefined, but the Documents .data() cannot be undefined when I check for the document existing above in my if block. Just curious on why that happens and if I have a logic issue here or not.

If the provided answer was helpful for you, please mark it as correct. — Doug Stevenson
– Doug Stevenson, Commented Aug 31, 2019 at 20:44

Doug Stevenson · Accepted Answer · 2019-08-31 20:08:44Z

6

TypeScript doesn't have any knowledge of the relationship between exists and data(). It just knows the signature of data() says that the return value can be DocumentSnapshot or undefined. So, you must satisfy the compiler by either:

First checking for "truthiness", then use the results if so:

const data = userDoc.data()
if (data) {
    // In this block, data is now typed as just DocumentData,
    // undefined is no longer an option.
}

Telling TypeScript that you know for sure that the results will be "truthy" by using the ! operator:

const data = userDoc.data()!  // data is now typed as just DocumentData

edited Aug 31, 2019 at 20:08

answered Aug 31, 2019 at 19:05

Doug Stevenson

321k37 gold badges458 silver badges474 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

lukasgeiter Over a year ago

@Doug Stevenson you actually only need one exclamation mark as documented here

Doug Stevenson Over a year ago

@lukasgeiter That's what I get for using Kotlin as well.

Sasha Koss · Accepted Answer · 2019-09-01 08:01:25Z

2

Unfortunately, even though Firestore adapters both for Node.js and the web are written mainly in TypeScript, they aren't designed for the language.

To solve the problem, I wrote Typesaurus, TypeScript-first ORM (or ODM if you wish) that solves this problem:

import { get, collection } from './src'
type User = { name: string }
const users = collection<User>('users')

async function main() {
  const user = await get(users, 'qwe') // get will return document or undefined
  if (user) {
    console.log(user.data.name) // user is Doc<User>
  } else {
    // user is undefined
  }
}

main()

answered Sep 1, 2019 at 8:01

Sasha Koss

16.5k4 gold badges23 silver badges27 bronze badges

Collectives™ on Stack Overflow

Firestore Document Typescript doc.data() undefined?

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related