FirestoreDataConverter interface

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

コンバータを使用すると、Firestore にオブジェクトを保存したり、Firestore からオブジェクトを取得したりするときに、ジェネリック型の引数を指定できます。

この文脈において、「AppModel」とは、関連する情報と機能をパッケージ化するためにアプリケーションで使用されるクラスです。このようなクラスには、たとえば、複雑なネストされたデータ型のプロパティ、メモ化に使用されるプロパティ、Firestore でサポートされていない型のプロパティ ( symbolやbigintなど) が含まれる可能性があります。 )、および複合操作を実行するヘルパー関数。このようなクラスは、Firestore データベースに保存するのに適していないか、保存することができません。代わりに、そのようなクラスのインスタンスは、他の POJO または POJO の配列内にネストされる可能性がある、プリミティブなプロパティだけを備えた「プレーン オールド JavaScript オブジェクト」 (POJO) に変換する必要があります。このコンテキストでは、このタイプは「DbModel」と呼ばれ、Firestore に永続化するのに適したオブジェクトになります。便宜上、アプリケーションはFirestoreDataConverterを実装し、 DocumentReferenceやQueryなどの Firestore オブジェクトにコンバータを登録できます。 , Firestore に保存するときにAppModel DbModelに自動的に変換し、Firestore から取得するときにDbModelをAppModelに変換します。

サイン：

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

メソッド

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

FirestoreDataConverter.fromFirestore()

Firestore データをAppModelType型のオブジェクトに変換するために Firestore SDK によって呼び出されます。 。 snapshot.data(options)を呼び出すことでデータにアクセスできます。 。

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

このメソッドをオーバーライドするには、「 」を参照してください。

サイン：

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

パラメーター

パラメータタイプ説明
スナップショットクエリドキュメントスナップショット<ドキュメントデータ、ドキュメントデータ>データとメタデータを含むQueryDocumentSnapshot 。
オプションスナップショットオプションdata()への最初の呼び出しからのSnapshotOptions 。

戻り値：

AppModelType

FirestoreDataConverter.toFirestore()

AppModelType型のカスタム モデル オブジェクトをDbModelType型のプレーン JavaScript オブジェクト (Firestore データベースに直接書き込むのに適しています) に変換するために Firestore SDK によって呼び出されます。 。 mergeおよびmergeFieldsでset()を使用するには、 toFirestore() PartialWithFieldValue<AppModelType>で定義する必要があります。

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

サイン：

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

パラメーター

パラメータタイプ説明
モデルオブジェクトフィールド値あり<AppModelType>

戻り値：

フィールド値あり<DbModelType>

FirestoreDataConverter.toFirestore()

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

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

サイン：

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

パラメーター

パラメータタイプ説明
モデルオブジェクト部分的フィールド値あり<AppModelType>
オプションオプションの設定

戻り値：

部分的フィールド値あり<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');
    }
}