このページは Cloud Translation API によって翻訳されました。

FirestoreDataConverter interface

AppModelType 型のユーザーオブジェクトを DbModelType 型の Firestore データに変換するために withConverter() が使用するコンバータ。

コンバータを使用すると、Firestore でオブジェクトを保存および取得する際に、汎用型の引数を指定できます。

ここでは、「AppModel」は関連する情報や機能をまとめるためにアプリケーションで使用されるクラスです。このようなクラスには、たとえば、ネストされた複雑なデータ型を持つプロパティ、メモ化に使用するプロパティ、Firestore でサポートされていない型のプロパティ（symbol や bigint など）、複合オペレーションを実行するヘルパー関数を含めることができます。このようなクラスは Firestore データベースへの保存には適していないか、保存できません。代わりに、そのようなクラスのインスタンスを「従来の JavaScript オブジェクト」に変換する必要があります。（POJO）このコンテキストでは、この型を「DbModel」と呼びます。Firestore での永続化に適したオブジェクトです利便性を考慮して、アプリケーションで FirestoreDataConverter を実装し、コンバータを DocumentReference や Query などの Firestore オブジェクトに登録することで、Firestore に保存する場合は AppModel を自動的に DbModel に変換し、Firestore から取得する場合は DbModel を AppModel に変換できます。

署名:

export declare interface FirestoreDataConverter<AppModelType, DbModelType extends DocumentData = DocumentData>

メソッド

メソッド	説明
fromFirestore(snapshot)	Firestore SDK によって呼び出され、Firestore データを `AppModelType` 型のオブジェクトに変換します。データにアクセスするには、`snapshot.data()` を呼び出します。一般に、`snapshot.data()` から返されるデータは `DbModelType` にキャストできます。Firestore ではデータベースにスキーマを適用しないため、保証はされません。たとえば、以前のバージョンのアプリケーションからの書き込みや、型コンバータを使用しない別のクライアントからの書き込みでは、異なるプロパティやプロパティ型のデータを書き込んでいた可能性があります。実装では、準拠していないデータから正常に復旧するか、エラーをスローするかを選択する必要があります。
toFirestore(modelObject)	`AppModelType` 型のカスタムモデルオブジェクトを `DbModelType` 型のプレーン JavaScript オブジェクト（Firestore データベースに直接書き込むのに適しています）に変換するために、Firestore SDK によって呼び出されます。setDoc()、. とともに使用します。`WithFieldValue<T>` 型は `T` を拡張し、deleteField() などの FieldValues をプロパティ値として使用することもできます。
toFirestore(modelObject, options)	`AppModelType` 型のカスタムモデルオブジェクトを `DbModelType` 型のプレーン JavaScript オブジェクト（Firestore データベースに直接書き込むのに適しています）に変換するために、Firestore SDK によって呼び出されます。setDoc()、および `merge:true` または `mergeFields` とともに使用します。`PartialWithFieldValue<T>` 型は `Partial<T>` を拡張し、arrayUnion() などの FieldValues をプロパティ値として使用できるようにします。また、ネストされたフィールドを省略できるようにすることで、ネストされた `Partial` もサポートします。

FirestoreDataConverter.fromFirestore()

Firestore SDK によって呼び出され、Firestore データを AppModelType 型のオブジェクトに変換します。データにアクセスするには、snapshot.data() を呼び出します。

通常、snapshot.data() から返されるデータは DbModelType にキャストできます。Firestore ではデータベースにスキーマを適用しないため、保証はされません。たとえば、以前のバージョンのアプリケーションからの書き込みや、型コンバータを使用しない別のクライアントからの書き込みでは、異なるプロパティやプロパティ型のデータを書き込んでいた可能性があります。実装では、準拠していないデータから正常に復旧するか、エラーをスローするかを選択する必要があります。

署名:

fromFirestore(snapshot: QueryDocumentSnapshot<DocumentData, DocumentData>): AppModelType;

パラメータ

パラメータ	型	説明
スナップショット	QueryDocumentSnapshot<DocumentData、DocumentData>	データとメタデータを含む `QueryDocumentSnapshot`。

戻り値:

AppModelType

FirestoreDataConverter.toFirestore()

AppModelType 型のカスタムモデルオブジェクトを DbModelType 型のプレーン JavaScript オブジェクト（Firestore データベースに直接書き込むのに適しています）に変換するために、Firestore SDK によって呼び出されます。setDoc()、.

WithFieldValue<T> 型は T を拡張して、deleteField() などの FieldValues をプロパティ値として使用することもできます。

署名:

toFirestore(modelObject: WithFieldValue<AppModelType>): WithFieldValue<DbModelType>;

パラメータ

パラメータ	型	説明
modelObject	WithFieldValue<AppModelType>

戻り値:

WithFieldValue<DbModelType>

FirestoreDataConverter.toFirestore()

AppModelType 型のカスタムモデルオブジェクトを DbModelType 型のプレーン JavaScript オブジェクト（Firestore データベースに直接書き込むのに適しています）に変換するために、Firestore SDK によって呼び出されます。setDoc() と、merge:true または mergeFields とともに使用します。

PartialWithFieldValue<T> 型は Partial<T> を拡張して、arrayUnion() などの FieldValues をプロパティ値として使用できるようにします。また、ネストされたフィールドを省略できるようにすることで、ネストされた Partial もサポートします。

署名:

toFirestore(modelObject: PartialWithFieldValue<AppModelType>, options: SetOptions): PartialWithFieldValue<DbModelType>;

パラメータ

パラメータ	型	説明
modelObject	PartialWithFieldValue<AppModelType>
オプション	SetOptions

戻り値:

PartialWithFieldValue<DbModelType>

例

簡単な例

const numberConverter = {
    toFirestore(value: WithFieldValue<number>) {
        return { value };
    },
    fromFirestore(snapshot: QueryDocumentSnapshot, options: SnapshotOptions) {
        return snapshot.data(options).value as number;
    }
};

async function simpleDemo(db: Firestore): Promise<void> {
    const documentRef = doc(db, 'values/value123').withConverter(numberConverter);

    // converters are used with `setDoc`, `addDoc`, and `getDoc`
    await setDoc(documentRef, 42);
    const snapshot1 = await getDoc(documentRef);
    assertEqual(snapshot1.data(), 42);

    // converters are not used when writing data with `updateDoc`
    await updateDoc(documentRef, { value: 999 });
    const snapshot2 = await getDoc(documentRef);
    assertEqual(snapshot2.data(), 999);
}

高度な例

// The Post class is a model that is used by our application.
// This class may have properties and methods that are specific
// to our application execution, which do not need to be persisted
// to Firestore.
class Post {
    constructor(
        readonly title: string,
        readonly author: string,
        readonly lastUpdatedMillis: number
    ) {}
    toString(): string {
        return `${this.title} by ${this.author}`;
    }
}

// The PostDbModel represents how we want our posts to be stored
// in Firestore. This DbModel has different properties (`ttl`,
// `aut`, and `lut`) from the Post class we use in our application.
interface PostDbModel {
    ttl: string;
    aut: { firstName: string; lastName: string };
    lut: Timestamp;
}

// The `PostConverter` implements `FirestoreDataConverter` and specifies
// how the Firestore SDK can convert `Post` objects to `PostDbModel`
// objects and vice versa.
class PostConverter implements FirestoreDataConverter<Post, PostDbModel> {
    toFirestore(post: WithFieldValue<Post>): WithFieldValue<PostDbModel> {
        return {
            ttl: post.title,
            aut: this._autFromAuthor(post.author),
            lut: this._lutFromLastUpdatedMillis(post.lastUpdatedMillis)
        };
    }

    fromFirestore(snapshot: QueryDocumentSnapshot, options: SnapshotOptions): Post {
        const data = snapshot.data(options) as PostDbModel;
        const author = `${data.aut.firstName} ${data.aut.lastName}`;
        return new Post(data.ttl, author, data.lut.toMillis());
    }

    _autFromAuthor(
        author: string | FieldValue
    ): { firstName: string; lastName: string } | FieldValue {
        if (typeof author !== 'string') {
            // `author` is a FieldValue, so just return it.
            return author;
        }
        const [firstName, lastName] = author.split(' ');
        return {firstName, lastName};
    }

    _lutFromLastUpdatedMillis(
        lastUpdatedMillis: number | FieldValue
    ): Timestamp | FieldValue {
        if (typeof lastUpdatedMillis !== 'number') {
            // `lastUpdatedMillis` must be a FieldValue, so just return it.
            return lastUpdatedMillis;
        }
        return Timestamp.fromMillis(lastUpdatedMillis);
    }
}

async function advancedDemo(db: Firestore): Promise<void> {
    // Create a `DocumentReference` with a `FirestoreDataConverter`.
    const documentRef = doc(db, 'posts/post123').withConverter(new PostConverter());

    // The `data` argument specified to `setDoc()` is type checked by the
    // TypeScript compiler to be compatible with `Post`. Since the `data`
    // argument is typed as `WithFieldValue<Post>` rather than just `Post`,
    // this allows properties of the `data` argument to also be special
    // Firestore values that perform server-side mutations, such as
    // `arrayRemove()`, `deleteField()`, and `serverTimestamp()`.
    await setDoc(documentRef, {
        title: 'My Life',
        author: 'Foo Bar',
        lastUpdatedMillis: serverTimestamp()
    });

    // The TypeScript compiler will fail to compile if the `data` argument to
    // `setDoc()` is _not_ compatible with `WithFieldValue<Post>`. This
    // type checking prevents the caller from specifying objects with incorrect
    // properties or property values.
    // @ts-expect-error "Argument of type { ttl: string; } is not assignable
    // to parameter of type WithFieldValue<Post>"
    await setDoc(documentRef, { ttl: 'The Title' });

    // When retrieving a document with `getDoc()` the `DocumentSnapshot`
    // object's `data()` method returns a `Post`, rather than a generic object,
    // which would have been returned if the `DocumentReference` did _not_ have a
    // `FirestoreDataConverter` attached to it.
    const snapshot1: DocumentSnapshot<Post> = await getDoc(documentRef);
    const post1: Post = snapshot1.data()!;
    if (post1) {
        assertEqual(post1.title, 'My Life');
        assertEqual(post1.author, 'Foo Bar');
    }

    // The `data` argument specified to `updateDoc()` is type checked by the
    // TypeScript compiler to be compatible with `PostDbModel`. Note that
    // unlike `setDoc()`, whose `data` argument must be compatible with `Post`,
    // the `data` argument to `updateDoc()` must be compatible with
    // `PostDbModel`. Similar to `setDoc()`, since the `data` argument is typed
    // as `WithFieldValue<PostDbModel>` rather than just `PostDbModel`, this
    // allows properties of the `data` argument to also be those special
    // Firestore values, like `arrayRemove()`, `deleteField()`, and
    // `serverTimestamp()`.
    await updateDoc(documentRef, {
        'aut.firstName': 'NewFirstName',
        lut: serverTimestamp()
    });

    // The TypeScript compiler will fail to compile if the `data` argument to
    // `updateDoc()` is _not_ compatible with `WithFieldValue<PostDbModel>`.
    // This type checking prevents the caller from specifying objects with
    // incorrect properties or property values.
    // @ts-expect-error "Argument of type { title: string; } is not assignable
    // to parameter of type WithFieldValue<PostDbModel>"
    await updateDoc(documentRef, { title: 'New Title' });
    const snapshot2: DocumentSnapshot<Post> = await getDoc(documentRef);
    const post2: Post = snapshot2.data()!;
    if (post2) {
        assertEqual(post2.title, 'My Life');
        assertEqual(post2.author, 'NewFirstName Bar');
    }
}