set

The method allows setting a document by its id. It’s available on Collection, Ref, and Doc.

The method returns Ref instance:

const ref = await db.users.set(userId, { name: "Sasha" });
//=> Ref<User>

Typesaurus expects you to pass complete data. If the document already exists, it will be overwritten.

It accepts a function as the argument that allows you to use the $ helper object:

await db.users.set(userId, ($) => ({
  name: "Sasha",
  createdAt: $.serverDate(),
}));

$ helper

The argument function receives the $ helper object as the first argument that provides write helpers.

$ type is TypesaurusCore.WriteHelpers.

$.serverDate

To assign a server date to a field, use $.serverDate:

await db.users.set(userId, ($) => ({
  name: "Sasha",
  // Set createdAt to the server date
  createdAt: $.serverDate(),
}));

It will assign the date when Firestore saves the document.

→ Read more about server dates.

Options

as

You can tell Typesaurus that it’s safe to set dates to server dates by passing the as option ("server" | "client"):

import { Typesaurus } from "typesaurus";

interface User {
  name: string;
  createdAt: Typesaurus.ServerDate;
}

// Can't assign Date to ServerDate
await db.users.set(userId, ($) => ({
  name: "Sasha",
  createdAt: new Date(),
}));
//=> The types of 'createdAt' are incompatible between these types.
//=>    Type 'Date' is missing the following properties from type 'ValueServerDate': type, kind

// OK!
await db.users.set(
  userId,
  ($) => ({
    name: "Sasha",
    // OK! We're on server
    createdAt: new Date(),
  }),
  { as: "server" },
);

By default, Typesaurus uses the "client" option.

→ Read more about server dates.