@firebase/firestore

ฟังก์ชั่น

ชั้นเรียน

อินเทอร์เฟซ

ตัวแปร

ประเภทนามแฝง

ฟังก์ชั่น (แอพ, ... )

getFirestore (แอพ)

ส่งคืนอินสแตนซ์ Firestore เริ่มต้นที่มีอยู่ซึ่งเชื่อมโยงกับ FirebaseApp ที่ให้ไว้ . หากไม่มีอินสแตนซ์ให้เริ่มต้นอินสแตนซ์ใหม่ด้วยการตั้งค่าเริ่มต้น

ลายเซ็น:

export declare function getFirestore(app: FirebaseApp): Firestore;

พารามิเตอร์

ผลตอบแทน:

ร้านดับเพลิง

อินสแตนซ์ Firestore เริ่มต้นของแอพที่ให้ไว้

getFirestore (แอพ, DatabaseID)

API นี้มีให้เป็นตัวอย่างสำหรับนักพัฒนาและอาจเปลี่ยนแปลงตามข้อเสนอแนะที่เราได้รับ อย่าใช้ API นี้ในสภาพแวดล้อมการผลิต

ส่งคืนอินสแตนซ์ Firestore ชื่อที่มีอยู่ซึ่งเกี่ยวข้องกับ FirebaseApp ที่ให้มา . หากไม่มีอินสแตนซ์ให้เริ่มต้นอินสแตนซ์ใหม่ด้วยการตั้งค่าเริ่มต้น

ลายเซ็น:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

พารามิเตอร์

ผลตอบแทน:

ร้านดับเพลิง

อินสแตนซ์ Firestore ที่มีชื่อของแอพที่ให้ไว้

InitializeFirestore (แอพ, การตั้งค่า, DatabaseID)

เริ่มต้นอินสแตนซ์ใหม่ของ Firestore ด้วยการตั้งค่าที่ให้ไว้ สามารถเรียกได้ก่อนฟังก์ชั่นอื่น ๆ รวมถึง getFirestore () . หากการตั้งค่าที่กำหนดเองว่างเปล่าฟังก์ชั่นนี้เทียบเท่ากับการเรียก getFirestore () .

ลายเซ็น:

export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;

พารามิเตอร์

ผลตอบแทน:

ร้านดับเพลิง

อินสแตนซ์ Firestore ที่เริ่มต้นใหม่

ฟังก์ชั่น (Firestore, ... )

ClearIndexedDBPersistence (Firestore)

ล้างที่เก็บข้อมูลถาวร ซึ่งรวมถึงการเขียนที่รอดำเนินการและเอกสารแคช

จะต้องถูกเรียกในขณะที่อินสแตนซ์ Firestore ไม่ได้เริ่มต้น (หลังจากแอปถูกยกเลิกหรือเมื่อแอปเริ่มต้นครั้งแรก) ในการเริ่มต้นฟังก์ชั่นนี้จะต้องเรียกก่อนฟังก์ชั่นอื่น ๆ (นอกเหนือจาก InitializeFirestore () หรือ getFirestore () )). หากอินสแตนซ์ Firestore ยังคงทำงานอยู่สัญญาจะถูกปฏิเสธด้วยรหัสข้อผิดพลาดของ failed-precondition .

ลายเซ็น:

export declare function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา <Void>

Promise ที่ได้รับการแก้ไขเมื่อมีการล้างพื้นที่เก็บข้อมูลถาวร มิฉะนั้นสัญญาจะถูกปฏิเสธด้วยข้อผิดพลาด

คอลเลกชัน (Firestore, Path, Pathsegments)

รับอินสแตนซ์ CollectionReference ที่อ้างถึงคอลเลกชันที่เส้นทางสัมบูรณ์ที่ระบุ

ลายเซ็น:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

พารามิเตอร์

ผลตอบแทน:

การรวบรวม < documentData , documentdata >

อินสแตนซ์ CollectionReference

ข้อยกเว้น

หากเส้นทางสุดท้ายมีจำนวนเซ็กเมนต์เท่ากันและไม่ชี้ไปที่คอลเลกชัน

CollectionGroup (Firestore, CollectionID)

สร้างและส่งคืนอิน Query แบบสอบถามใหม่ที่มีเอกสารทั้งหมดในฐานข้อมูลที่มีอยู่ในคอลเลกชันหรือการรวบรวมย่อยด้วย collectionId ที่กำหนด .

ลายเซ็น:

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

พารามิเตอร์

ผลตอบแทน:

แบบสอบถาม < documentData , documentdata >

Query ที่สร้างขึ้น .

ConnectFirestoreEmulator (Firestore, โฮสต์, พอร์ต, ตัวเลือก)

ปรับเปลี่ยนอินสแตนซ์นี้เพื่อสื่อสารกับเครื่องจำลองคลาวด์ไฟร์สโคป

ลายเซ็น:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

พารามิเตอร์

ผลตอบแทน:

เป็นโมฆะ

Disablenetwork (Firestore)

ปิดใช้งานการใช้งานเครือข่ายสำหรับอินสแตนซ์นี้ สามารถเปิดใช้งานได้อีกครั้งผ่าน enableNetwork () . ในขณะที่เครือข่ายถูกปิดใช้งานการโทร snapshot, getDoc() หรือ getDocs() การโทรจะส่งคืนผลลัพธ์จากแคชและการดำเนินการเขียนใด ๆ จะถูกคิวจนกว่าเครือข่ายจะถูกกู้คืน

ลายเซ็น:

export declare function disableNetwork(firestore: Firestore): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา <Void>

Promise ที่ได้รับการแก้ไขเมื่อเครือข่ายถูกปิดใช้งาน

หมอ (Firestore, Path, Pathsegments)

รับอินสแตนซ์ DocumentReference ที่อ้างถึงเอกสารที่เส้นทางสัมบูรณ์ที่ระบุ

ลายเซ็น:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

พารามิเตอร์

ผลตอบแทน:

เอกสารเกี่ยวกับเอกสาร < documentData , documentdata >

อินสแตนซ์ DocumentReference

ข้อยกเว้น

หากเส้นทางสุดท้ายมีจำนวนกลุ่มคี่และไม่ชี้ไปที่เอกสาร

enableindexeddbpersistence (Firestore, Presentencesettings)

ฟังก์ชั่นนี้จะถูกลบออกในรุ่นสำคัญในอนาคต ให้ตั้ง FirestoreSettings.localCache เป็นอินสแตนซ์ของ PersistentLocalCache เพื่อเปิดแคช IndexedDB การเรียกใช้ฟังก์ชั่นนี้เมื่อมีการระบุ FirestoreSettings.localCache แล้วจะทำการยกเว้น

พยายามเปิดใช้งานที่เก็บข้อมูลถาวรหากเป็นไปได้

ในความล้มเหลว enableIndexedDbPersistence() จะปฏิเสธสัญญาหรือโยนข้อยกเว้น มีสาเหตุหลายประการที่ทำให้เกิดความล้มเหลวซึ่งสามารถระบุได้ด้วย code ในข้อผิดพลาด

* ความล้มเหลวข้อตกลง: แอพเปิดอยู่แล้วในแท็บเบราว์เซอร์อื่น * Unimplemented: เบราว์เซอร์ไม่เข้ากันกับการใช้งานการคงอยู่แบบออฟไลน์

โปรดทราบว่าแม้หลังจากความล้มเหลวอินสแตนซ์ Firestore จะยังคงใช้งานได้อย่างไรก็ตามการคงอยู่ของออฟไลน์จะถูกปิดใช้งาน

ไม่สามารถใช้การคงอยู่ในสภาพแวดล้อม node.js

ลายเซ็น:

export declare function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา <Void>

Promise ที่แสดงถึงการเปิดใช้งานที่เก็บข้อมูลถาวรได้สำเร็จ

enableMultitabIndexedDBPersistence (Firestore)

ฟังก์ชั่นนี้จะถูกลบออกในรุ่นสำคัญในอนาคต ให้ตั้งค่า FirestoreSettings.localCache เป็นอินสแตนซ์ของ PersistentLocalCache เพื่อเปิดแคช IndexedDB การเรียกใช้ฟังก์ชั่นนี้เมื่อมีการระบุ FirestoreSettings.localCache แล้วจะทำการยกเว้น

ความพยายามที่จะเปิดใช้งานที่เก็บข้อมูลแบบถาวรแบบหลายแท็บถ้าเป็นไปได้ หากเปิดใช้งานในทุกแท็บการดำเนินการทั้งหมดจะแชร์การเข้าถึงการคงอยู่ของท้องถิ่นรวมถึงการดำเนินการที่ใช้ร่วมกันของการสืบค้นและการอัปเดตเอกสารท้องถิ่นที่ได้รับการชดเชยเวลาแฝงในทุกอินสแตนซ์ที่เชื่อมต่อทั้งหมด

ในความล้มเหลว enableMultiTabIndexedDbPersistence() จะปฏิเสธสัญญาหรือโยนข้อยกเว้น มีสาเหตุหลายประการที่ทำให้เกิดความล้มเหลวซึ่งสามารถระบุได้ด้วย code ในข้อผิดพลาด

* ความล้มเหลวในการกำหนด: แอพเปิดอยู่แล้วในแท็บเบราว์เซอร์อื่นและไม่ได้เปิดใช้งานหลายแท็บ * Unimplemented: เบราว์เซอร์ไม่เข้ากันกับการใช้งานการคงอยู่แบบออฟไลน์

โปรดทราบว่าแม้หลังจากความล้มเหลวอินสแตนซ์ Firestore จะยังคงใช้งานได้อย่างไรก็ตามการคงอยู่ของออฟไลน์จะถูกปิดใช้งาน

ลายเซ็น:

export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา <Void>

Promise ที่แสดงถึงการเปิดใช้งานที่เก็บข้อมูลถาวรได้สำเร็จ

enableNetwork (Firestore)

เปิดใช้งานการใช้เครือข่ายสำหรับอินสแตนซ์ Firestore นี้อีกครั้งหลังจากการโทรไปยัง disablenetwork ก่อนหน้า () .

ลายเซ็น:

export declare function enableNetwork(firestore: Firestore): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา <Void>

Promise ที่ได้รับการแก้ไขเมื่อเปิดใช้งานเครือข่าย

GetPersistentCacheIndexManager (Firestore)

ส่งคืนตัวจัดการดัชนี PersistentCache ที่ใช้โดยวัตถุ Firestore ที่กำหนด

อินสแตนซ์ PersistentCacheIndexManager หรือ null หากไม่ได้ใช้ที่เก็บถาวรในเครื่อง

ลายเซ็น:

export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;

พารามิเตอร์

ผลตอบแทน:

PresententCacheIndexManager | โมฆะ

Loadbundle (Firestore, Bundledata)

โหลดชุด Firestore ลงในแคชท้องถิ่น

ลายเซ็น:

export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;

พารามิเตอร์

ผลตอบแทน:

loadbundletask

วัตถุ LoadBundleTask ซึ่งแจ้งผู้โทรด้วยการอัปเดตความคืบหน้าและเหตุการณ์ที่เสร็จสมบูรณ์หรือข้อผิดพลาด มันสามารถใช้เป็น Promise<LoadBundleTaskProgress> .

NamedQuery (Firestore, ชื่อ)

อ่าน แบบสอบถาม Firestore จากแคชท้องถิ่นที่ระบุด้วยชื่อที่กำหนด

แบบสอบถามที่มีชื่อจะถูกบรรจุไว้ในชุดข้อมูลบนฝั่งเซิร์ฟเวอร์ (พร้อมกับเอกสารผลลัพธ์) และโหลดไปยังแคชท้องถิ่นโดยใช้ loadBundle . เมื่ออยู่ในแคชท้องถิ่นให้ใช้วิธีนี้เพื่อแยก แบบสอบถาม ตามชื่อ

ลายเซ็น:

export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

พารามิเตอร์

ผลตอบแทน:

สัญญา < คำถาม | null>

Promise ที่ได้รับการแก้ไขด้วยการสืบค้นหรือ null .

Onsnapshotsinsync (Firestore, Observer)

แนบผู้ฟังสำหรับเหตุการณ์สแน็ปช็อตในซิงค์ เหตุการณ์สแน็ปช็อตในซิงค์บ่งชี้ว่าผู้ฟังทั้งหมดที่ได้รับผลกระทบจากการเปลี่ยนแปลงที่กำหนดได้ยิงแม้ว่าการเปลี่ยนแปลงที่สร้างขึ้นจากเซิร์ฟเวอร์เดียวจะส่งผลกระทบต่อผู้ฟังหลายคน

หมายเหตุ: เหตุการณ์สแน็ปช็อตในซิงค์เท่านั้นระบุว่าผู้ฟังจะซิงค์กัน แต่ไม่เกี่ยวข้องกับสแน็ปช็อตเหล่านั้นที่ซิงค์กับเซิร์ฟเวอร์หรือไม่ ใช้ snapshotmetadata ในผู้ฟังแต่ละคนเพื่อตรวจสอบว่าสแน็ปช็อตนั้นมาจากแคชหรือเซิร์ฟเวอร์หรือไม่

ลายเซ็น:

export declare function onSnapshotsInSync(firestore: Firestore, observer: {
    next?: (value: void) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

ยกเลิกการสมัคร

ฟังก์ชั่นยกเลิกการสมัครที่สามารถเรียกให้ยกเลิกการฟังสแน็ปช็อตได้

Onsnapshotsinsync (Firestore, Onsync)

แนบผู้ฟังสำหรับเหตุการณ์สแน็ปช็อตในซิงค์ เหตุการณ์สแน็ปช็อตในซิงค์บ่งชี้ว่าผู้ฟังทั้งหมดที่ได้รับผลกระทบจากการเปลี่ยนแปลงที่กำหนดได้ยิงแม้ว่าการเปลี่ยนแปลงที่สร้างขึ้นจากเซิร์ฟเวอร์เดียวจะส่งผลกระทบต่อผู้ฟังหลายคน

หมายเหตุ: เหตุการณ์สแน็ปช็อตในซิงค์เท่านั้นระบุว่าผู้ฟังจะซิงค์กัน แต่ไม่เกี่ยวข้องกับสแน็ปช็อตเหล่านั้นที่ซิงค์กับเซิร์ฟเวอร์หรือไม่ ใช้ SnapshotMetadata ในผู้ฟังแต่ละคนเพื่อตรวจสอบว่าสแน็ปช็อตนั้นมาจากแคชหรือเซิร์ฟเวอร์หรือไม่

ลายเซ็น:

export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

ยกเลิกการสมัคร

ฟังก์ชั่นยกเลิกการสมัครที่สามารถเรียกให้ยกเลิกการฟังสแน็ปช็อตได้

RunTransaction (Firestore, UpdateFunction, ตัวเลือก)

ดำเนินการ updateFunction ที่กำหนดจากนั้นพยายามที่จะกระทำการเปลี่ยนแปลงที่ใช้ภายในธุรกรรม หากเอกสารใด ๆ ที่อ่านภายในการทำธุรกรรมมีการเปลี่ยนแปลง Cloud Firestore จะให้ updateFunction . หากล้มเหลวในการกระทำหลังจาก 5 ครั้งการทำธุรกรรมจะล้มเหลว

จำนวนการเขียนสูงสุดที่อนุญาตในการทำธุรกรรมเดียวคือ 500

ลายเซ็น:

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

พารามิเตอร์

ผลตอบแทน:

สัญญา <t>

หากธุรกรรมเสร็จสมบูรณ์สำเร็จหรือถูกยกเลิกอย่างชัดเจน ( updateFunction ส่งคืนสัญญาที่ล้มเหลว) สัญญาที่ส่งคืนโดย updateFunction จะถูกส่งคืนที่นี่ มิฉะนั้นหากการทำธุรกรรมล้มเหลวสัญญาที่ถูกปฏิเสธด้วยข้อผิดพลาดความล้มเหลวที่สอดคล้องกันจะถูกส่งคืน

SetIndExConfiguration (Firestore, การกำหนดค่า)

API นี้มีให้เป็นตัวอย่างสำหรับนักพัฒนาและอาจเปลี่ยนแปลงตามข้อเสนอแนะที่เราได้รับ อย่าใช้ API นี้ในสภาพแวดล้อมการผลิต

แทนที่จะสร้างดัชนีแคชด้วยตนเองให้พิจารณาใช้ enablePersistentCacheIndexAutoCreation() เพื่อให้ SDK ตัดสินใจว่าจะสร้างดัชนีแคชสำหรับการสืบค้นที่ทำงานในเครื่องหรือไม่

กำหนดค่าการจัดทำดัชนีสำหรับการดำเนินการแบบสอบถามในท้องถิ่น การกำหนดค่าดัชนีก่อนหน้านี้จะถูกแทนที่ Promise จะแก้ไขได้เมื่อการกำหนดค่าดัชนียังคงมีอยู่

รายการดัชนีเองถูกสร้างขึ้นแบบอะซิงโครนัส คุณสามารถใช้การสืบค้นที่ต้องการการจัดทำดัชนีต่อไปแม้ว่าจะยังไม่สามารถใช้ดัชนีได้ก็ตาม การดำเนินการแบบสอบถามจะเริ่มใช้ดัชนีโดยอัตโนมัติเมื่อมีการเขียนรายการดัชนีแล้ว

ดัชนีได้รับการสนับสนุนเฉพาะการคงอยู่ของดัชนี DB หากไม่ได้เปิดใช้งาน indexedDB การกำหนดค่าดัชนีใด ๆ จะถูกละเว้น

ลายเซ็น:

export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา <Void>

Promise ที่แก้ไขได้เมื่อมีการกำหนดค่าดัชนีทั้งหมดสำเร็จ

ข้อยกเว้น

firestoreerror หากรูปแบบ JSON ไม่ถูกต้อง

SetIndExConfiguration (Firestore, JSON)

API นี้มีให้เป็นตัวอย่างสำหรับนักพัฒนาและอาจเปลี่ยนแปลงตามข้อเสนอแนะที่เราได้รับ อย่าใช้ API นี้ในสภาพแวดล้อมการผลิต

แทนที่จะสร้างดัชนีแคชด้วยตนเองให้พิจารณาใช้ enablePersistentCacheIndexAutoCreation() เพื่อให้ SDK ตัดสินใจว่าจะสร้างดัชนีแคชสำหรับการสืบค้นที่ทำงานในเครื่องหรือไม่

กำหนดค่าการจัดทำดัชนีสำหรับการดำเนินการแบบสอบถามในท้องถิ่น การกำหนดค่าดัชนีก่อนหน้านี้จะถูกแทนที่ Promise จะแก้ไขได้เมื่อการกำหนดค่าดัชนียังคงมีอยู่

รายการดัชนีเองถูกสร้างขึ้นแบบอะซิงโครนัส คุณสามารถใช้การสืบค้นที่ต้องการการจัดทำดัชนีต่อไปแม้ว่าจะยังไม่สามารถใช้ดัชนีได้ก็ตาม การดำเนินการแบบสอบถามจะเริ่มใช้ดัชนีโดยอัตโนมัติเมื่อมีการเขียนรายการดัชนีแล้ว

ดัชนีได้รับการสนับสนุนเฉพาะการคงอยู่ของดัชนี DB เรียกใช้ enableIndexedDbPersistence() หรือ enableMultiTabIndexedDbPersistence() ก่อนตั้งค่าการกำหนดค่าดัชนี หากไม่ได้เปิดใช้งาน indexedDB การกำหนดค่าดัชนีใด ๆ จะถูกละเว้น

วิธีการยอมรับรูปแบบ JSON ที่ส่งออกโดย Firebase CLI ( firebase firestore:indexes ). หากรูปแบบ JSON ไม่ถูกต้องวิธีนี้จะเกิดข้อผิดพลาด

ลายเซ็น:

export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา <Void>

Promise ที่แก้ไขได้เมื่อมีการกำหนดค่าดัชนีทั้งหมดสำเร็จ

ข้อยกเว้น

firestoreerror หากรูปแบบ JSON ไม่ถูกต้อง

ยุติ (Firestore)

ยุติอินสแตนซ์ Firestore ที่ให้ไว้

หลังจากการโทร terminate() เฉพาะฟังก์ชัน clearIndexedDbPersistence() เท่านั้น ฟังก์ชั่นอื่น ๆ จะโยน FirestoreError .

หากต้องการเริ่มต้นใหม่หลังจากการเลิกจ้างให้สร้างอินสแตนซ์ใหม่ของ FirebaseFirestore ด้วย getFirestore () .

การเลิกจ้างไม่ได้ยกเลิกการเขียนที่ค้างอยู่และสัญญาใด ๆ ที่กำลังรอการตอบกลับจากเซิร์ฟเวอร์จะไม่ได้รับการแก้ไข หากคุณเปิดใช้งานการคงอยู่ในครั้งต่อไปที่คุณเริ่มอินสแตนซ์นี้จะกลับมาส่งการเขียนเหล่านี้ไปยังเซิร์ฟเวอร์

ลายเซ็น:

export declare function terminate(firestore: Firestore): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา <Void>

Promise ที่ได้รับการแก้ไขเมื่ออินสแตนซ์ถูกยกเลิกสำเร็จ

WaitForPendingWrites (Firestore)

รอจนกว่าจะมีการเขียนทั้งหมดที่รอการเขียนสำหรับผู้ใช้ที่ใช้งานอยู่ได้รับการยอมรับจากแบ็กเอนด์

สัญญาที่ส่งคืนจะแก้ไขได้ทันทีหากไม่มีการเขียนที่โดดเด่น มิฉะนั้นสัญญาจะรอคำเขียนที่ออกก่อนหน้านี้ทั้งหมด (รวมถึงที่เขียนในเซสชันแอพก่อนหน้า) แต่มันไม่รอการเขียนที่เพิ่มขึ้นหลังจากเรียกใช้ฟังก์ชั่น หากคุณต้องการรอการเขียนเพิ่มเติมให้โทรหา waitForPendingWrites() อีกครั้ง

คำสัญญาใด ๆ ที่โดดเด่น waitForPendingWrites() จะถูกปฏิเสธระหว่างการเปลี่ยนแปลงของผู้ใช้

ลายเซ็น:

export declare function waitForPendingWrites(firestore: Firestore): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา <Void>

Promise ที่แก้ไขเมื่อการเขียนที่ค้างอยู่ในปัจจุบันได้รับการยอมรับจากแบ็กเอนด์

Writebatch (Firestore)

สร้างแบทช์เขียนที่ใช้สำหรับการเขียนหลายครั้งเป็นการดำเนินการอะตอมเดียว จำนวนการเขียนสูงสุดที่อนุญาตใน writebatch เดียวคือ 500

ซึ่งแตกต่างจากการทำธุรกรรมการเขียนแบทช์จะคงอยู่แบบออฟไลน์ดังนั้นจึงเป็นที่นิยมเมื่อคุณไม่จำเป็นต้องกำหนดเงื่อนไขการเขียนของคุณเกี่ยวกับข้อมูลการอ่าน

ลายเซ็น:

export declare function writeBatch(firestore: Firestore): WriteBatch;

พารามิเตอร์

ผลตอบแทน:

batch

batch batch ที่สามารถใช้ในการดำเนินการเขียนหลายครั้ง

การทำงาน()

นับ()

สร้างวัตถุรวมฟีลล์ที่สามารถใช้ในการคำนวณจำนวนเอกสารในชุดผลลัพธ์ของแบบสอบถาม

ลายเซ็น:

export declare function count(): AggregateField<number>;

ผลตอบแทน:

ฟีลล์รวม <จำนวน>

DELETEFIELD ()

ส่งคืน Sentinel เพื่อใช้กับ updateDoC () หรือ setDoc () ด้วย {merge: true} เพื่อทำเครื่องหมายฟิลด์สำหรับการลบ

ลายเซ็น:

export declare function deleteField(): FieldValue;

ผลตอบแทน:

ค่าเงิน

DocumentId ()

ส่งคืน Sentinel FieldPath พิเศษเพื่ออ้างถึง ID ของเอกสาร สามารถใช้ในการสืบค้นเพื่อเรียงลำดับหรือกรองด้วยรหัสเอกสาร

ลายเซ็น:

export declare function documentId(): FieldPath;

ผลตอบแทน:

สนามบิน

getFirestore ()

ส่งคืนอินสแตนซ์ Firestore เริ่มต้นที่มีอยู่ซึ่งเชื่อมโยงกับ FirebaseApp เริ่มต้น . หากไม่มีอินสแตนซ์ให้เริ่มต้นอินสแตนซ์ใหม่ด้วยการตั้งค่าเริ่มต้น

ลายเซ็น:

export declare function getFirestore(): Firestore;

ผลตอบแทน:

ร้านดับเพลิง

อินสแตนซ์ Firestore เริ่มต้นของแอพเริ่มต้น

Memoryeagergarbagecollector ()

สร้างอินสแตนซ์ของ MemoryEagerGarbageCollector . นี่เป็นตัวสะสมขยะเริ่มต้นเว้นแต่จะมีการระบุอย่างชัดเจนเป็นอย่างอื่น

ลายเซ็น:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

ผลตอบแทน:

Memoryeagerbagecollector

PresententMultipleTabManager ()

สร้างอินสแตนซ์ของ PersistentMultipleTabManager .

ลายเซ็น:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

ผลตอบแทน:

PresententMultipleTabManager

servertimestamp ()

ส่งคืน Sentinel ที่ใช้กับ setDoc () หรือ updateDoC () เพื่อรวมการประทับเวลาที่สร้างจากเซิร์ฟเวอร์ในข้อมูลที่เป็นลายลักษณ์อักษร

ลายเซ็น:

export declare function serverTimestamp(): FieldValue;

ผลตอบแทน:

ค่าเงิน

ฟังก์ชั่น (databaseid, ... )

GetFirestore (DatabaseID)

API นี้มีให้เป็นตัวอย่างสำหรับนักพัฒนาและอาจเปลี่ยนแปลงตามข้อเสนอแนะที่เราได้รับ อย่าใช้ API นี้ในสภาพแวดล้อมการผลิต

ส่งคืนอินสแตนซ์ Firestore ชื่อที่มีอยู่ซึ่งเชื่อมโยงกับ FirebaseApp เริ่มต้น . หากไม่มีอินสแตนซ์ให้เริ่มต้นอินสแตนซ์ใหม่ด้วยการตั้งค่าเริ่มต้น

ลายเซ็น:

export declare function getFirestore(databaseId: string): Firestore;

พารามิเตอร์

ผลตอบแทน:

ร้านดับเพลิง

อินสแตนซ์ Firestore ชื่อของแอพเริ่มต้น

ฟังก์ชั่น (องค์ประกอบ, ... )

Arrayremove (องค์ประกอบ)

ส่งคืนค่าพิเศษที่สามารถใช้กับ setDoc () หรือที่บอกให้เซิร์ฟเวอร์ลบองค์ประกอบที่กำหนดออกจากค่าอาร์เรย์ใด ๆ ที่มีอยู่แล้วบนเซิร์ฟเวอร์ อินสแตนซ์ทั้งหมดของแต่ละองค์ประกอบที่ระบุจะถูกลบออกจากอาร์เรย์ If the field being modified is not already an array it will be overwritten with an empty array.

ลายเซ็น:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

พารามิเตอร์

ผลตอบแทน:

FieldValue

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

arrayUnion(elements)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements.

ลายเซ็น:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

พารามิเตอร์

ผลตอบแทน:

FieldValue

The FieldValue sentinel for use in a call to setDoc() or updateDoc() .

function(field, ...)

average(field)

Create an AggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

ลายเซ็น:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

พารามิเตอร์

ผลตอบแทน:

AggregateField <number | null>

sum(field)

Create an AggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

ลายเซ็น:

export declare function sum(field: string | FieldPath): AggregateField<number>;

พารามิเตอร์

ผลตอบแทน:

AggregateField <จำนวน>

function(fieldPath, ...)

orderBy(fieldPath, directionStr)

Creates a QueryOrderByConstraint that sorts the query result by the specified field, optionally in descending order instead of ascending.

ลายเซ็น:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryOrderByConstraint

The created QueryOrderByConstraint .

where(fieldPath, opStr, value)

Creates a QueryFieldFilterConstraint that enforces that documents must contain the specified field and that the value should satisfy the relation constraint provided.

ลายเซ็น:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryFieldFilterConstraint

The created QueryFieldFilterConstraint .

function(fieldValues, ...)

endAt(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

ลายเซ็น:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(fieldValues)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

ลายเซ็น:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

ลายเซ็น:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(fieldValues)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

ลายเซ็น:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

Removes all persistent cache indexes.

Please note this function will also deletes indexes generated by setIndexConfiguration() , which is deprecated.

ลายเซ็น:

export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

พารามิเตอร์

ผลตอบแทน:

เป็นโมฆะ

disablePersistentCacheIndexAutoCreation(indexManager)

Stops creating persistent cache indexes automatically for local query execution. The indexes which have been created by calling enablePersistentCacheIndexAutoCreation() still take effect.

ลายเซ็น:

export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

พารามิเตอร์

ผลตอบแทน:

เป็นโมฆะ

enablePersistentCacheIndexAutoCreation(indexManager)

Enables the SDK to create persistent cache indexes automatically for local query execution when the SDK believes cache indexes can help improve performance.

This feature is disabled by default.

ลายเซ็น:

export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

พารามิเตอร์

ผลตอบแทน:

เป็นโมฆะ

function(left, ...)

aggregateFieldEqual(left, right)

Compares two 'AggregateField ` instances for equality.

ลายเซ็น:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

พารามิเตอร์

ผลตอบแทน:

บูลีน

aggregateQuerySnapshotEqual(left, right)

Compares two AggregateQuerySnapshot instances for equality.

Two AggregateQuerySnapshot instances are considered "equal" if they have underlying queries that compare equal, and the same data.

ลายเซ็น:

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

พารามิเตอร์

ผลตอบแทน:

บูลีน

true if the objects are "equal", as defined above, or false otherwise.

queryEqual(left, right)

Returns true if the provided queries point to the same collection and apply the same constraints.

ลายเซ็น:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

พารามิเตอร์

ผลตอบแทน:

บูลีน

true if the references point to the same location in the same Firestore database.

refEqual(left, right)

Returns true if the provided references are equal.

ลายเซ็น:

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

พารามิเตอร์

ผลตอบแทน:

บูลีน

true if the references point to the same location in the same Firestore database.

snapshotEqual(left, right)

Returns true if the provided snapshots are equal.

ลายเซ็น:

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

พารามิเตอร์

ผลตอบแทน:

บูลีน

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

ลายเซ็น:

export declare function limit(limit: number): QueryLimitConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryLimitConstraint

The created QueryLimitConstraint .

limitToLast(limit)

Creates a QueryLimitConstraint that only returns the last matching documents.

You must specify at least one orderBy clause for limitToLast queries, otherwise an exception will be thrown during execution.

ลายเซ็น:

export declare function limitToLast(limit: number): QueryLimitConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

ลายเซ็น:

export declare function setLogLevel(logLevel: LogLevel): void;

พารามิเตอร์

ผลตอบแทน:

เป็นโมฆะ

function(n, ...)

increment(n)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to increment the field's current value by the given value.

If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.

If the current field value is not of type number , or if the field does not yet exist, the transformation sets the field to the given value.

ลายเซ็น:

export declare function increment(n: number): FieldValue;

พารามิเตอร์

ผลตอบแทน:

FieldValue

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.

Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, are downloaded. This function can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

ลายเซ็น:

export declare function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

พารามิเตอร์

ผลตอบแทน:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

ตัวอย่าง

const aggregateSnapshot = await getAggregateFromServer(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCountFromServer(query)

Calculates the number of documents in the result set of the given query without actually downloading the documents.

Using this function to count the documents is efficient because only the final count, not the documents' data, is downloaded. This function can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

ลายเซ็น:

export declare function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

พารามิเตอร์

ผลตอบแทน:

Promise< AggregateQuerySnapshot <{ count: AggregateField <number>; }, AppModelType, DbModelType>>

A Promise that will be resolved with the count; the count can be retrieved from snapshot.data().count , where snapshot is the AggregateQuerySnapshot to which the returned Promise resolves.

getDocs(query)

Executes the query and returns the results as a QuerySnapshot .

ลายเซ็น:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

พารามิเตอร์

ผลตอบแทน:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromCache(query)

Executes the query and returns the results as a QuerySnapshot from cache. Returns an empty result set if no documents matching the query are currently cached.

ลายเซ็น:

export declare function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

พารามิเตอร์

ผลตอบแทน:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromServer(query)

Executes the query and returns the results as a QuerySnapshot from the server. Returns an error if the network is not available.

ลายเซ็น:

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

พารามิเตอร์

ผลตอบแทน:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

onSnapshot(query, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

ลายเซ็น:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

ยกเลิกการสมัคร

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

ลายเซ็น:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

ยกเลิกการสมัคร

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

ลายเซ็น:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

ยกเลิกการสมัคร

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

ลายเซ็น:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

ยกเลิกการสมัคร

An unsubscribe function that can be called to cancel the snapshot listener.

query(query, compositeFilter, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

ลายเซ็น:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

พารามิเตอร์

ผลตอบแทน:

แบบสอบถาม <AppModelType, DbModelType>

ข้อยกเว้น

if any of the provided query constraints cannot be combined with the existing or new constraints.

query(query, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

ลายเซ็น:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

พารามิเตอร์

ผลตอบแทน:

แบบสอบถาม <AppModelType, DbModelType>

ข้อยกเว้น

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(queryConstraints, ...)

and(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a conjunction of the given filter constraints. A conjunction filter includes a document if it satisfies all of the given filters.

ลายเซ็น:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

or(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a disjunction of the given filter constraints. A disjunction filter includes a document if it satisfies any of the given filters.

ลายเซ็น:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

function(reference, ...)

addDoc(reference, data)

Add a new document to specified CollectionReference with the given data, assigning it a document ID automatically.

ลายเซ็น:

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

พารามิเตอร์

ผลตอบแทน:

Promise< DocumentReference <AppModelType, DbModelType>>

A Promise resolved with a DocumentReference pointing to the newly created document after it has been written to the backend (Note that it won't resolve while you're offline).

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

ลายเซ็น:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

พารามิเตอร์

ผลตอบแทน:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

ข้อยกเว้น

If the final path has an even number of segments and does not point to a collection.

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

ลายเซ็น:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

พารามิเตอร์

ผลตอบแทน:

CollectionReference < DocumentData , DocumentData >

The CollectionReference instance.

ข้อยกเว้น

If the final path has an even number of segments and does not point to a collection.

deleteDoc(reference)

Deletes the document referred to by the specified DocumentReference .

ลายเซ็น:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

Promise<void>

A Promise resolved once the document has been successfully deleted from the backend (note that it won't resolve while you're offline).

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference .

ลายเซ็น:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

พารามิเตอร์

ผลตอบแทน:

DocumentReference <AppModelType, DbModelType>

The DocumentReference instance.

ข้อยกเว้น

If the final path has an odd number of segments and does not point to a document.

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path.

ลายเซ็น:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

พารามิเตอร์

ผลตอบแทน:

DocumentReference < DocumentData , DocumentData >

The DocumentReference instance.

ข้อยกเว้น

If the final path has an odd number of segments and does not point to a document.

getDoc(reference)

Reads the document referred to by this DocumentReference .

ลายเซ็น:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

พารามิเตอร์

ผลตอบแทน:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromCache(reference)

Reads the document referred to by this DocumentReference from cache. Returns an error if the document is not currently cached.

ลายเซ็น:

export declare function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

พารามิเตอร์

ผลตอบแทน:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromServer(reference)

Reads the document referred to by this DocumentReference from the server. Returns an error if the network is not available.

ลายเซ็น:

export declare function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

พารามิเตอร์

ผลตอบแทน:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

onSnapshot(reference, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

ลายเซ็น:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

ยกเลิกการสมัคร

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

ลายเซ็น:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

ยกเลิกการสมัคร

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

ลายเซ็น:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

ยกเลิกการสมัคร

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

ลายเซ็น:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

ยกเลิกการสมัคร

An unsubscribe function that can be called to cancel the snapshot listener.

setDoc(reference, data)

Writes to the document referred to by this DocumentReference . If the document does not yet exist, it will be created.

ลายเซ็น:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

setDoc(reference, data, options)

Writes to the document referred to by the specified DocumentReference . If the document does not yet exist, it will be created. If you provide merge or mergeFields , the provided data can be merged into an existing document.

ลายเซ็น:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, data)

Updates fields in the document referred to by the specified DocumentReference . The update will fail if applied to a document that does not exist.

ลายเซ็น:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, field, value, moreFieldsAndValues)

Updates fields in the document referred to by the specified DocumentReference The update will fail if applied to a document that does not exist.

Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

ลายเซ็น:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

Promise<void>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

function(settings, ...)

memoryLocalCache(settings)

Creates an instance of MemoryLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

ลายเซ็น:

export declare function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;

พารามิเตอร์

ผลตอบแทน:

MemoryLocalCache

memoryLruGarbageCollector(settings)

Creates an instance of MemoryLruGarbageCollector .

A target size can be specified as part of the setting parameter. The collector will start deleting documents once the cache size exceeds the given size. The default cache size is 40MB (40 * 1024 * 1024 bytes).

ลายเซ็น:

export declare function memoryLruGarbageCollector(settings?: {
    cacheSizeBytes?: number;
}): MemoryLruGarbageCollector;

พารามิเตอร์

ผลตอบแทน:

MemoryLruGarbageCollector

persistentLocalCache(settings)

Creates an instance of PersistentLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Persistent cache cannot be used in a Node.js environment.

ลายเซ็น:

export declare function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

พารามิเตอร์

ผลตอบแทน:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

ลายเซ็น:

export declare function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

พารามิเตอร์

ผลตอบแทน:

PersistentSingleTabManager

function(snapshot, ...)

endAt(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

ลายเซ็น:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

ลายเซ็น:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided document (exclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

ลายเซ็น:

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

ลายเซ็น:

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

CACHE_SIZE_UNLIMITED

Constant used to indicate the LRU garbage collection should be disabled. Set this value as the cacheSizeBytes on the settings passed to the Firestore instance.

ลายเซ็น:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

Returns a new map where every key is prefixed with the outer key appended to a dot.

ลายเซ็น:

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

AggregateFieldType

The union of all AggregateField types that are supported by Firestore.

ลายเซ็น:

export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;

AggregateSpecData

A type whose keys are taken from an AggregateSpec , and whose values are the result of the aggregation performed by the corresponding AggregateField from the input AggregateSpec .

ลายเซ็น:

export declare type AggregateSpecData<T extends AggregateSpec> = {
    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};

AggregateType

Union type representing the aggregate type to be performed.

ลายเซ็น:

export declare type AggregateType = 'count' | 'avg' | 'sum';

ChildUpdateFields

Helper for calculating the nested fields for a given type T1. This is needed to distribute union types such as undefined | {...} (happens for optional props) or {a: A} | {b: B} .

In this use case, V is used to distribute the union types of T[K] on Record , since T[K] is evaluated as an expression and not distributed.

See https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types

ลายเซ็น:

export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;

DocumentChangeType

The type of a DocumentChange may be 'added', 'removed', or 'modified'.

ลายเซ็น:

export declare type DocumentChangeType = 'added' | 'removed' | 'modified';

FirestoreErrorCode

The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (eg an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.

ลายเซ็น:

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

FirestoreLocalCache

Union type from all supported SDK cache layer.

ลายเซ็น:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

Describe the source a query listens to.

Set to default to listen to both cache and server changes. Set to cache to listen to changes in cache only.

ลายเซ็น:

export declare type ListenSource = 'default' | 'cache';

MemoryGarbageCollector

Union type from all support gabage collectors for memory local cache.

ลายเซ็น:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

For each field (eg 'bar'), find all nested keys (eg { 'bar.baz': T1, 'bar.qux': T2 } ). Intersect them together to make a single map containing all possible keys that are all marked as optional

ลายเซ็น:

export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
    [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;

OrderByDirection

The direction of a orderBy() clause is specified as 'desc' or 'asc' (descending or ascending).

ลายเซ็น:

export declare type OrderByDirection = 'desc' | 'asc';

PartialWithFieldValue

Similar to Typescript's Partial<T> , but allows nested fields to be omitted and FieldValues to be passed in as property values.

ลายเซ็น:

export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);

PersistentTabManager

A union of all available tab managers.

ลายเซ็น:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

ดั้งเดิม

Primitive types.

ลายเซ็น:

export declare type Primitive = string | number | boolean | undefined | null;

QueryConstraintType

Describes the different query constraints available in this SDK.

ลายเซ็น:

export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';

QueryFilterConstraint

QueryFilterConstraint is a helper union type that represents QueryFieldFilterConstraint and QueryCompositeFilterConstraint .

ลายเซ็น:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint is a helper union type that represents QueryConstraints which are used to narrow or order the set of documents, but that do not explicitly filter on a document field. QueryNonFilterConstraint s are created by invoking orderBy() , เริ่มต้นที่() , startAfter() , endBefore() , endAt() , limit() or limitToLast() and can then be passed to query() to create a new query instance that also contains the QueryConstraint .

ลายเซ็น:

export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;

SetOptions

An options object that configures the behavior of setDoc() , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true .

ลายเซ็น:

export declare type SetOptions = {
    readonly merge?: boolean;
} | {
    readonly mergeFields?: Array<string | FieldPath>;
};

TaskState

Represents the state of bundle loading tasks.

Both 'Error' and 'Success' are sinking state: task will abort or complete and there will be no more updates after they are reported.

ลายเซ็น:

export declare type TaskState = 'Error' | 'Running' | 'Success';

UnionToIntersection

Given a union type U = T1 | T2 | ... , returns an intersected type (T1 & T2 & ...) .

Uses distributive conditional types and inference from conditional types. This works because multiple candidates for the same type variable in contra-variant positions causes an intersection type to be inferred. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -พิมพ์

ลายเซ็น:

export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;

UpdateData

Update data (for use with updateDoc() ) that consists of field paths (eg 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. FieldValues can be passed in as property values.

ลายเซ็น:

export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;

WhereFilterOp

Filter conditions in a where() clause are specified using the strings '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', and 'not-in'.

ลายเซ็น:

export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';

WithFieldValue

Allows FieldValues to be passed in as a property value while maintaining type safety.

ลายเซ็น:

export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);