FirestoreDataConverter interface

AppModelType टाइप के उपयोगकर्ता ऑब्जेक्ट को DbModelType टाइप के Firebase डेटा में बदलने के लिए, withConverter() ने कन्वर्टर का इस्तेमाल किया.

कन्वर्टर का इस्तेमाल करने से, आपको Firestore से ऑब्जेक्ट को स्टोर और वापस पाने के दौरान सामान्य टाइप के आर्ग्युमेंट तय करने की सुविधा मिलती है.

इस संदर्भ में, "AppModel" एक क्लास है जिसका इस्तेमाल ऐप्लिकेशन में संबंधित जानकारी और फ़ंक्शन को एक साथ पैकेज करने के लिए किया जाता है. उदाहरण के लिए, ऐसे क्लास में जटिल, नेस्ट किए गए डेटा टाइप वाली प्रॉपर्टी, मेमो बनाने के लिए इस्तेमाल की जाने वाली प्रॉपर्टी, Firestore के साथ काम न करने वाली प्रॉपर्टी (जैसे कि symbol और bigint), और कंपाउंड ऑपरेशन पूरे करने वाले हेल्पर फ़ंक्शन हो सकते हैं. इस तरह की क्लास Firestore डेटाबेस में सेव करने के लिए सही और/या मुमकिन नहीं होती हैं. इसके बजाय, इस तरह की क्लास के इंस्टेंस को "पुराने JavaScript ऑब्जेक्ट" में बदलना होगा (POJO) खास तौर पर शुरुआती प्रॉपर्टी वाले, जो संभावित रूप से अन्य POJO या 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() पर कॉल करके डेटा ऐक्सेस किया जा सकता है.आम तौर पर, snapshot.data() से वापस मिलने वाला डेटा DbModelType में कास्ट किया जा सकता है; हालांकि, इसकी कोई गारंटी नहीं है, क्योंकि Firestore, डेटाबेस पर स्कीमा लागू नहीं करता. उदाहरण के लिए, ऐप्लिकेशन के पिछले वर्शन से डेटा लिखता है या किसी ऐसे दूसरे क्लाइंट से लिखता है जो टाइप कन्वर्टर का इस्तेमाल नहीं करता है, तो हो सकता है कि लिखा गया डेटा अलग-अलग प्रॉपर्टी और/या प्रॉपर्टी टाइप के साथ हो. लागू करने के लिए यह चुनना होगा कि क्या गैर-कंफ़ॉर्मिंग डेटा को ग्रेसफ़ुल तरीके से वापस लाना है या गड़बड़ी की गड़बड़ी करनी है.
toFirestore(modelObject)	AppModelType टाइप के कस्टम मॉडल ऑब्जेक्ट को DbModelType टाइप के सादे JavaScript ऑब्जेक्ट (सीधे तौर पर Firestore डेटाबेस में लिखने के लिए सही) में बदलने के लिए, Firestore SDK टूल का इस्तेमाल किया गया. इसका इस्तेमाल setDoc() और .के साथ किया जाता है. WithFieldValue<T> प्रकार T को भी प्रॉपर्टी की वैल्यू के तौर पर इस्तेमाल करने की अनुमति देने के लिए T का इस्तेमाल करता है. इससे deleteField() जैसे फ़ील्ड वैल्यू का इस्तेमाल भी किया जा सकता है.
toFirestore(modelObject, विकल्प)	AppModelType टाइप के कस्टम मॉडल ऑब्जेक्ट को DbModelType टाइप के सादे JavaScript ऑब्जेक्ट (सीधे तौर पर Firestore डेटाबेस में लिखने के लिए सही) में बदलने के लिए, Firestore SDK टूल का इस्तेमाल किया गया. इसका इस्तेमाल setDoc() के साथ और merge:true या mergeFields के साथ किया जाता है.PartialWithFieldValue<T> टाइप, Partial<T> को बड़ा करता है, ताकि arrayUnion() जैसे फ़ील्ड वैल्यू को प्रॉपर्टी वैल्यू के तौर पर इस्तेमाल किया जा सके. यह नेस्ट किए गए Partial के साथ भी काम करता है, ताकि नेस्ट किए गए फ़ील्ड को छोड़ा जा सके.

FirestoreDataConverter.fromFirestore()

Firestore डेटा को AppModelType टाइप के ऑब्जेक्ट में बदलने के लिए, Firestore SDK टूल को कॉल किया गया. snapshot.data() पर कॉल करके अपना डेटा ऐक्सेस किया जा सकता है.

आम तौर पर, snapshot.data() से लौटाए गए डेटा को DbModelType में कास्ट किया जा सकता है; हालांकि, इसकी कोई गारंटी नहीं है, क्योंकि Firestore, डेटाबेस पर स्कीमा लागू नहीं करता. उदाहरण के लिए, ऐप्लिकेशन के पिछले वर्शन से डेटा लिखता है या किसी ऐसे दूसरे क्लाइंट से लिखता है जो टाइप कन्वर्टर का इस्तेमाल नहीं करता है, तो हो सकता है कि लिखा गया डेटा अलग-अलग प्रॉपर्टी और/या प्रॉपर्टी टाइप के साथ हो. लागू करने के लिए यह चुनना होगा कि क्या गैर-कंफ़ॉर्मिंग डेटा को ग्रेसफ़ुल तरीके से वापस लाना है या गड़बड़ी की गड़बड़ी करनी है.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
स्नैपशॉट	QueryDocumentSnapshot<DocumentData, DocumentData>	एक QueryDocumentSnapshot, जिसमें आपका डेटा और मेटाडेटा होता है.

लौटाए जाने वाले प्रॉडक्ट:

ऐपमॉडल टाइप

FirestoreDataConverter.toFirestore()

AppModelType टाइप के कस्टम मॉडल ऑब्जेक्ट को DbModelType टाइप के सादे JavaScript ऑब्जेक्ट (सीधे तौर पर Firestore डेटाबेस में लिखने के लिए सही) में बदलने के लिए, Firestore SDK टूल का इस्तेमाल किया गया. setDoc() और .

WithFieldValue<T> टाइप, T को भी बड़ा करता है, ताकि deleteField() जैसे फ़ील्ड वैल्यू को प्रॉपर्टी की वैल्यू के तौर पर इस्तेमाल किया जा सके.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
मॉडलऑब्जेक्ट	WithFieldValue<AppModelType>

लौटाए जाने वाले प्रॉडक्ट:

WithFieldValue<DbModelType>

FirestoreDataConverter.toFirestore()

AppModelType टाइप के कस्टम मॉडल ऑब्जेक्ट को DbModelType टाइप के सादे JavaScript ऑब्जेक्ट (सीधे तौर पर Firestore डेटाबेस में लिखने के लिए सही) में बदलने के लिए, Firestore SDK टूल का इस्तेमाल किया गया. setDoc() के साथ और merge:true या mergeFields के साथ इस्तेमाल किया जाता है.

PartialWithFieldValue<T> टाइप की वैल्यू के तौर पर Partial<T> को बड़ा किया जा सकता है, ताकि arrayUnion() जैसे फ़ील्ड वैल्यू को प्रॉपर्टी की वैल्यू के तौर पर इस्तेमाल किया जा सके. यह नेस्ट किए गए Partial के साथ भी काम करता है, ताकि नेस्ट किए गए फ़ील्ड को छोड़ा जा सके.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
मॉडलऑब्जेक्ट	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');
    }
}