database package

ฐานข้อมูลเรียลไทม์ Firebase

ฟังก์ชั่น

ชั้นเรียน

อินเทอร์เฟซ

พิมพ์นามแฝง

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

getDatabase (แอป, URL)

ส่งคืนอินสแตนซ์ของ Realtime Database SDK ที่เชื่อมโยงกับ FirebaseApp ที่ให้มา . เริ่มต้นอินสแตนซ์ใหม่ด้วยการตั้งค่าเริ่มต้น หากไม่มีอินสแตนซ์หรือหากอินสแตนซ์ที่มีอยู่ใช้ URL ฐานข้อมูลที่กำหนดเอง

ลายเซ็น:

export declare function getDatabase(app?: FirebaseApp, url?: string): Database;

พารามิเตอร์

ผลตอบแทน:

ฐานข้อมูล

Database ฐานข้อมูลของแอพที่ให้ไว้

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

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

แก้ไขอินสแตนซ์ที่ให้ไว้เพื่อสื่อสารกับตัวจำลองฐานข้อมูลเรียลไทม์

หมายเหตุ: วิธีนี้จะต้องเรียกก่อนการดำเนินการอื่น ๆ

ลายเซ็น:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

พารามิเตอร์

ผลตอบแทน:

เป็นโมฆะ

GOOFFLINE (DB)

ตัดการเชื่อมต่อจากเซิร์ฟเวอร์ (การดำเนินการฐานข้อมูลทั้งหมดจะเสร็จสมบูรณ์แบบออฟไลน์)

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

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

ในการเชื่อมต่อกับฐานข้อมูลอีกครั้งและเริ่มรับเหตุการณ์ระยะไกลดู goOnline() .

ลายเซ็น:

export declare function goOffline(db: Database): void;

พารามิเตอร์

ผลตอบแทน:

เป็นโมฆะ

Goonline (db)

เชื่อมต่อกับเซิร์ฟเวอร์ใหม่และซิงโครไนซ์สถานะฐานข้อมูลออฟไลน์กับสถานะเซิร์ฟเวอร์

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

ลายเซ็น:

export declare function goOnline(db: Database): void;

พารามิเตอร์

ผลตอบแทน:

เป็นโมฆะ

Ref (db, Path)

ส่งคืน Reference ที่แสดงตำแหน่งในฐานข้อมูลที่สอดคล้องกับเส้นทางที่ให้ไว้ หากไม่มีการให้เส้นทาง Reference จะชี้ไปที่รูทของฐานข้อมูล

ลายเซ็น:

export declare function ref(db: Database, path?: string): DatabaseReference;

พารามิเตอร์

ผลตอบแทน:

การอ้างอิงฐานข้อมูล

หากมีการจัดเตรียมเส้นทาง Reference ที่ชี้ไปยังเส้นทางที่ให้ไว้ มิฉะนั้น Reference ชี้ไปที่รูทของฐานข้อมูล

reffromurl (db, url)

ส่งคืน Reference ที่แสดงตำแหน่งในฐานข้อมูลที่สอดคล้องกับ URL Firebase ที่ให้มา

ข้อยกเว้นจะถูกโยนลงหาก URL ไม่ใช่ URL ฐานข้อมูล Firedbase ที่ถูกต้องหรือมีโดเมนที่แตกต่างจากอินสแตนซ์ฐาน Database ปัจจุบัน

โปรดทราบว่าพารามิเตอร์การสืบค้นทั้งหมด ( orderBy , limitToLast ฯลฯ ) ถูกละเว้นและไม่ได้ใช้กับ Reference ที่ส่งคืน .

ลายเซ็น:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

พารามิเตอร์

ผลตอบแทน:

การอ้างอิงฐานข้อมูล

Reference ชี้ไปที่ URL Firebase ที่ให้มา

การทำงาน()

forcelongpolling ()

บังคับใช้การใช้ longpolling แทน websockets สิ่งนี้จะถูกละเว้นหากใช้โปรโตคอล WebSocket ใน DatabaseUrl

ลายเซ็น:

export declare function forceLongPolling(): void;

ผลตอบแทน:

เป็นโมฆะ

ForceWebsockets ()

บังคับให้ใช้ WebSockets แทนการพ่นนาน

ลายเซ็น:

export declare function forceWebSockets(): void;

ผลตอบแทน:

เป็นโมฆะ

orderbykey ()

สร้าง QueryConstraint ใหม่ที่สั่งซื้อตามคีย์

เรียงลำดับผลลัพธ์ของการสืบค้นด้วยค่าคีย์ (จากน้อยไปมาก)

คุณสามารถอ่านเพิ่มเติมเกี่ยวกับ orderByKey() ใน ข้อมูลการเรียงลำดับ .

ลายเซ็น:

export declare function orderByKey(): QueryConstraint;

ผลตอบแทน:

QueryConstraint

orderbypriority ()

สร้าง QueryConstraint ใหม่ที่สั่งซื้อตามลำดับความสำคัญ

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

ลายเซ็น:

export declare function orderByPriority(): QueryConstraint;

ผลตอบแทน:

QueryConstraint

orderbyValue ()

สร้าง QueryConstraint ใหม่ที่สั่งซื้อตามมูลค่า

หากลูกของแบบสอบถามเป็นค่าสเกลาร์ทั้งหมด (สตริงตัวเลขหรือบูลีน) คุณสามารถสั่งซื้อผลลัพธ์ได้ด้วยค่า (จากน้อยไปมาก)

คุณสามารถอ่านเพิ่มเติมเกี่ยวกับ orderByValue() ใน ข้อมูลการเรียงลำดับ .

ลายเซ็น:

export declare function orderByValue(): QueryConstraint;

ผลตอบแทน:

QueryConstraint

servertimestamp ()

ส่งคืนค่าตัวยึดตำแหน่งสำหรับการเติมเงินอัตโนมัติการประทับเวลาปัจจุบัน (เวลานับตั้งแต่ยุค UNIX ในมิลลิวินาที) ตามที่กำหนดโดยเซิร์ฟเวอร์ Firebase

ลายเซ็น:

export declare function serverTimestamp(): object;

ผลตอบแทน:

วัตถุ

ฟังก์ชั่น (เดลต้า, ... )

เพิ่มขึ้น (เดลต้า)

ส่งคืนค่าตัวยึดที่สามารถใช้ในการเพิ่มค่าฐานข้อมูลปัจจุบันโดยเดลต้าที่ให้ไว้

ลายเซ็น:

export declare function increment(delta: number): object;

พารามิเตอร์

ผลตอบแทน:

วัตถุ

ค่าตัวยึดสำหรับการแก้ไขข้อมูลด้านเซิร์ฟเวอร์แบบอะตอม

ฟังก์ชั่น(เปิดใช้งาน, ...)

enablelogging (เปิดใช้งาน, ถาวร)

บันทึกข้อมูลการดีบักไปยังคอนโซล

ลายเซ็น:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

พารามิเตอร์

ผลตอบแทน:

ใดๆ

ฟังก์ชั่น (ขีด จำกัด , ... )

จำกัดToFirst(จำกัด)

สร้าง QueryConstraint ใหม่ว่าหาก จำกัด จำนวนเด็กแรกที่เฉพาะเจาะจง

วิธี limitToFirst() ใช้เพื่อตั้งค่าจำนวนเด็กสูงสุดที่จะซิงค์สำหรับการโทรกลับที่กำหนด หากเราตั้งค่าขีด จำกัด 100 เราจะเริ่มต้นได้มากถึง 100 เหตุการณ์ child_added เท่านั้น หากเรามีข้อความน้อยกว่า 100 ข้อความที่เก็บไว้ในฐานข้อมูลของเราเหตุการณ์ child_added จะยิงสำหรับแต่ละข้อความ อย่างไรก็ตามหากเรามีข้อความมากกว่า 100 ข้อความเราจะได้รับกิจกรรม child_added สำหรับข้อความที่สั่งซื้อ 100 รายการแรกเท่านั้น เมื่อรายการเปลี่ยนไปเราจะได้รับกิจกรรม child_removed สำหรับแต่ละรายการที่หลุดออกจากรายการที่ใช้งานอยู่เพื่อให้จำนวนทั้งหมดอยู่ที่ 100

คุณสามารถอ่านเพิ่มเติมเกี่ยวกับ limitToFirst() ใน การกรองข้อมูล .

ลายเซ็น:

export declare function limitToFirst(limit: number): QueryConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryConstraint

Limittolast (ขีด จำกัด )

สร้าง QueryConstraint ใหม่ที่ จำกัด ให้ส่งคืนเฉพาะจำนวนเด็กที่ระบุล่าสุดเท่านั้น

วิธี limitToLast() ใช้เพื่อตั้งค่าจำนวนเด็กสูงสุดที่จะซิงค์สำหรับการโทรกลับที่กำหนด หากเราตั้งค่าขีด จำกัด 100 เราจะเริ่มต้นได้มากถึง 100 เหตุการณ์ child_added เท่านั้น หากเรามีข้อความน้อยกว่า 100 ข้อความที่เก็บไว้ในฐานข้อมูลของเราเหตุการณ์ child_added จะยิงสำหรับแต่ละข้อความ อย่างไรก็ตามหากเรามีข้อความมากกว่า 100 ข้อความเราจะได้รับกิจกรรม child_added สำหรับข้อความที่สั่งซื้อ 100 ข้อความสุดท้ายเท่านั้น เมื่อรายการเปลี่ยนไปเราจะได้รับกิจกรรม child_removed สำหรับแต่ละรายการที่หลุดออกจากรายการที่ใช้งานอยู่เพื่อให้จำนวนทั้งหมดอยู่ที่ 100

คุณสามารถอ่านเพิ่มเติมเกี่ยวกับ limitToLast() ใน การกรองข้อมูล .

ลายเซ็น:

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

พารามิเตอร์

ผลตอบแทน:

QueryConstraint

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

enablelogging (logger)

บันทึกข้อมูลการดีบักไปยังคอนโซล

ลายเซ็น:

export declare function enableLogging(logger: (message: string) => unknown): any;

พารามิเตอร์

ผลตอบแทน:

ใดๆ

ฟังก์ชั่น (ผู้ปกครอง, ... )

เด็ก (ผู้ปกครองเส้นทาง)

ได้รับ Reference สำหรับตำแหน่งที่เส้นทางสัมพัทธ์ที่ระบุ

เส้นทางสัมพัทธ์อาจเป็นชื่อเด็กง่าย ๆ (ตัวอย่างเช่น "ADA") หรือเส้นทางที่คั่นด้วยสแลชที่ลึกกว่า (ตัวอย่างเช่น "ada/name/first")

ลายเซ็น:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

พารามิเตอร์

ผลตอบแทน:

การอ้างอิงฐานข้อมูล

ตำแหน่งเด็กที่ระบุ

push (parent, value)

สร้างตำแหน่งเด็กใหม่โดยใช้คีย์ที่ไม่ซ้ำกันและส่งคืน Reference .

นี่เป็นรูปแบบที่พบบ่อยที่สุดสำหรับการเพิ่มข้อมูลในชุดของรายการ

หากคุณให้คุณค่าในการ push() ค่าถูกเขียนไปยังตำแหน่งที่สร้างขึ้น หากคุณไม่ผ่านค่าไม่มีอะไรเขียนไปยังฐานข้อมูลและเด็กยังคงว่างเปล่า (แต่คุณสามารถใช้ Reference ที่อื่นได้)

คีย์ที่ไม่ซ้ำกันที่สร้างโดย push() ได้รับคำสั่งซื้อตามเวลาปัจจุบันดังนั้นรายการที่ได้ของรายการจะถูกเรียงลำดับตามลำดับเวลา คีย์ได้รับการออกแบบให้ไม่สามารถคาดเดาได้ (มี 72 บิตสุ่มของเอนโทรปี)

ดู ผนวกรายการข้อมูล . ดู 2^120 วิธีเพื่อให้แน่ใจว่าตัวระบุที่ไม่ซ้ำกัน .

ลายเซ็น:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

พารามิเตอร์

ผลตอบแทน:

Thenablereference

Promise รวมและ Reference ; แก้ไขเมื่อการเขียนเสร็จสมบูรณ์ แต่สามารถใช้งานได้ทันทีเพื่อ Reference ถึงตำแหน่งเด็ก

ฟังก์ชั่น (เส้นทาง, ... )

orderbychild (เส้นทาง)

สร้าง QueryConstraint ใหม่ที่สั่งซื้อโดยคีย์เด็กที่ระบุ

แบบสอบถามสามารถสั่งซื้อได้ทีละคีย์เท่านั้น การเรียกสั่ง orderByChild() หลายครั้งในแบบสอบถามเดียวกันเป็นข้อผิดพลาด

การสืบค้น Firebase ช่วยให้คุณสามารถสั่งซื้อข้อมูลของคุณโดยคีย์ลูกใด ๆ ได้ทันที อย่างไรก็ตามหากคุณรู้ล่วงหน้าว่าดัชนีของคุณจะเป็นอย่างไรคุณสามารถกำหนดได้ผ่านกฎ. Indexon ในกฎความปลอดภัยของคุณเพื่อประสิทธิภาพที่ดีขึ้น ดู https://firebase.google.com/docs/database/security/indexing-data กฎสำหรับข้อมูลเพิ่มเติม

คุณสามารถอ่านเพิ่มเติมเกี่ยวกับ orderByChild() ใน ข้อมูลการเรียงลำดับ .

ลายเซ็น:

export declare function orderByChild(path: string): QueryConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryConstraint

ฟังก์ชั่น (คำถาม, ... )

รับ (คำถาม)

ได้รับผลลัพธ์ที่ทันสมัยที่สุดสำหรับแบบสอบถามนี้

ลายเซ็น:

export declare function get(query: Query): Promise<DataSnapshot>;

พารามิเตอร์

ผลตอบแทน:

สัญญา < datasnapshot >

Promise ที่แก้ไขให้กับ DataSnapshot ที่เกิดขึ้นหากมีค่าใช้จ่ายหรือปฏิเสธหากไคลเอนต์ไม่สามารถส่งคืนค่าได้ (เช่นถ้าเซิร์ฟเวอร์ไม่สามารถเข้าถึงได้และไม่มีอะไรแคช)

ปิด (Query, EventType, Callback)

แยกการโทรกลับก่อนหน้านี้กับ on*() ( onValue ที่สอดคล้องกัน , onChildAdded ) ผู้ฟัง หมายเหตุ: นี่ไม่ใช่วิธีที่แนะนำในการลบผู้ฟัง โปรดใช้ฟังก์ชั่นการโทรกลับที่ส่งคืนจากการเรียกกลับ on* ที่เกี่ยวข้อง

แยกการโทรกลับก่อนหน้านี้ด้วย on*() . การโทร off() บนผู้ฟังหลักจะไม่ลบผู้ฟังที่ลงทะเบียนโดยอัตโนมัติบนโหนดลูก off() จะต้องถูกเรียกใช้ผู้ฟังเด็กคนใดเพื่อลบการโทรกลับ

หากไม่ได้ระบุการโทรกลับการเรียกกลับทั้งหมดสำหรับ eventType ที่ระบุจะถูกลบออก ในทำนองเดียวกันหากไม่มีการระบุ EventType การเรียกกลับทั้งหมดสำหรับ Reference จะถูกลบออก

ผู้ฟังแต่ละคนยังสามารถลบออกได้โดยเรียกร้องการเรียกคืนการสมัครสมาชิก

ลายเซ็น:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

พารามิเตอร์

ผลตอบแทน:

เป็นโมฆะ

onchildadded (Query, Callback, CancelCallback)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

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

ลายเซ็น:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

onchildadded (คำถามการโทรกลับ, ตัวเลือก)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

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

ลายเซ็น:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

onchildadded (Query, Callback, CancelCallback, ตัวเลือก)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

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

ลายเซ็น:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

OnchildChanged (Query, Callback, CancelCallback)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onChildChanged จะถูกเรียกใช้เมื่อข้อมูลที่เก็บไว้ในเด็ก (หรือลูกหลานใด ๆ ) เปลี่ยนแปลง โปรดทราบว่าเหตุการณ์ child_changed เดี่ยวอาจแสดงถึงการเปลี่ยนแปลงหลายครั้งกับเด็ก DataSnapshot ที่ส่งผ่านไปยังการโทรกลับจะมีเนื้อหาเด็กใหม่ สำหรับวัตถุประสงค์ในการสั่งซื้อการโทรกลับจะผ่านอาร์กิวเมนต์ที่สองซึ่งเป็นสตริงที่มีคีย์ของเด็กพี่น้องก่อนหน้านี้โดยการเรียงลำดับหรือเป็น null ถ้าเป็นลูกคนแรก

ลายเซ็น:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

OnchildChanged (Query, Callback, Options)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onChildChanged จะถูกเรียกใช้เมื่อข้อมูลที่เก็บไว้ในเด็ก (หรือลูกหลานใด ๆ ) เปลี่ยนแปลง โปรดทราบว่าเหตุการณ์ child_changed เดี่ยวอาจแสดงถึงการเปลี่ยนแปลงหลายครั้งกับเด็ก DataSnapshot ที่ส่งผ่านไปยังการโทรกลับจะมีเนื้อหาเด็กใหม่ สำหรับวัตถุประสงค์ในการสั่งซื้อการโทรกลับจะผ่านอาร์กิวเมนต์ที่สองซึ่งเป็นสตริงที่มีคีย์ของเด็กพี่น้องก่อนหน้านี้โดยการเรียงลำดับหรือเป็น null ถ้าเป็นลูกคนแรก

ลายเซ็น:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

OnchildChanged (Query, Callback, CancelCallback, ตัวเลือก)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onChildChanged จะถูกเรียกใช้เมื่อข้อมูลที่เก็บไว้ในเด็ก (หรือลูกหลานใด ๆ ) เปลี่ยนแปลง โปรดทราบว่าเหตุการณ์ child_changed เดี่ยวอาจแสดงถึงการเปลี่ยนแปลงหลายครั้งกับเด็ก DataSnapshot ที่ส่งผ่านไปยังการโทรกลับจะมีเนื้อหาเด็กใหม่ สำหรับวัตถุประสงค์ในการสั่งซื้อการโทรกลับจะผ่านอาร์กิวเมนต์ที่สองซึ่งเป็นสตริงที่มีคีย์ของเด็กพี่น้องก่อนหน้านี้โดยการเรียงลำดับหรือเป็น null ถ้าเป็นลูกคนแรก

ลายเซ็น:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

onChildMoved(สอบถาม โทรกลับ ยกเลิกโทรกลับ)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onChildMoved จะถูกทริกเกอร์เมื่อคำสั่งเรียงลำดับของเด็กเปลี่ยนไปซึ่งตำแหน่งที่สัมพันธ์กับการเปลี่ยนแปลงของพี่น้อง DataSnapshot ที่ส่งผ่านไปยังการโทรกลับจะเป็นข้อมูลของเด็กที่ย้าย นอกจากนี้ยังผ่านอาร์กิวเมนต์ที่สองซึ่งเป็นสตริงที่มีคีย์ของเด็กพี่น้องก่อนหน้านี้โดยการเรียงลำดับหรือเป็น null ถ้าเป็นลูกคนแรก

ลายเซ็น:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

onchildmoved (คำถามการโทรกลับ, ตัวเลือก)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onChildMoved จะถูกทริกเกอร์เมื่อคำสั่งเรียงลำดับของเด็กเปลี่ยนไปซึ่งตำแหน่งที่สัมพันธ์กับการเปลี่ยนแปลงของพี่น้อง DataSnapshot ที่ส่งผ่านไปยังการโทรกลับจะเป็นข้อมูลของเด็กที่ย้าย นอกจากนี้ยังผ่านอาร์กิวเมนต์ที่สองซึ่งเป็นสตริงที่มีคีย์ของเด็กพี่น้องก่อนหน้านี้โดยการเรียงลำดับหรือเป็น null ถ้าเป็นลูกคนแรก

ลายเซ็น:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

OnchildMoved (Query, Callback, CancelCallback, ตัวเลือก)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onChildMoved จะถูกทริกเกอร์เมื่อคำสั่งเรียงลำดับของเด็กเปลี่ยนไปซึ่งตำแหน่งที่สัมพันธ์กับการเปลี่ยนแปลงของพี่น้อง DataSnapshot ที่ส่งผ่านไปยังการโทรกลับจะเป็นข้อมูลของเด็กที่ย้าย นอกจากนี้ยังผ่านอาร์กิวเมนต์ที่สองซึ่งเป็นสตริงที่มีคีย์ของเด็กพี่น้องก่อนหน้านี้โดยการเรียงลำดับหรือเป็น null ถ้าเป็นลูกคนแรก

ลายเซ็น:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

onchildremoved (Query, Callback, CancelCallback)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onChildRemoved จะถูกทริกเกอร์ทุกครั้งที่เด็กถูกลบออก DataSnapshot ที่ผ่านเข้าสู่การโทรกลับจะเป็นข้อมูลเก่าสำหรับเด็กที่ถูกลบออก เด็กจะถูกลบออกเมื่อ:

• ลูกค้าโทรออกอย่างชัดเจน remove() ในเด็กคนนั้นหรือหนึ่งในบรรพบุรุษของมัน - set(null) ในเด็กคนนั้นหรือหนึ่งในบรรพบุรุษของมัน - เด็กคนนั้นมีลูกทั้งหมดถูกลบออก - มีการสืบค้น เด็กออก (เพราะมันมีการเรียงลำดับเปลี่ยนหรือขีด จำกัด สูงสุดถูกตี)

ลายเซ็น:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

onchildremoved (คำถามการโทรกลับ, ตัวเลือก)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onChildRemoved จะถูกทริกเกอร์ทุกครั้งที่เด็กถูกลบออก DataSnapshot ที่ผ่านเข้าสู่การโทรกลับจะเป็นข้อมูลเก่าสำหรับเด็กที่ถูกลบออก เด็กจะถูกลบออกเมื่อ:

• ลูกค้าโทรออกอย่างชัดเจน remove() ในเด็กคนนั้นหรือหนึ่งในบรรพบุรุษของมัน - set(null) ในเด็กคนนั้นหรือหนึ่งในบรรพบุรุษของมัน - เด็กคนนั้นมีลูกทั้งหมดถูกลบออก - มีการสืบค้น เด็กออก (เพราะมันมีการเรียงลำดับเปลี่ยนหรือขีด จำกัด สูงสุดถูกตี)

ลายเซ็น:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

OnChildRemoved (Query, Callback, CancelCallback, ตัวเลือก)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onChildRemoved จะถูกทริกเกอร์ทุกครั้งที่เด็กถูกลบออก DataSnapshot ที่ผ่านเข้าสู่การโทรกลับจะเป็นข้อมูลเก่าสำหรับเด็กที่ถูกลบออก เด็กจะถูกลบออกเมื่อ:

• ลูกค้าโทรออกอย่างชัดเจน remove() ในเด็กคนนั้นหรือหนึ่งในบรรพบุรุษของมัน - set(null) ในเด็กคนนั้นหรือหนึ่งในบรรพบุรุษของมัน - เด็กคนนั้นมีลูกทั้งหมดถูกลบออก - มีการสืบค้น เด็กออก (เพราะมันมีการเรียงลำดับเปลี่ยนหรือขีด จำกัด สูงสุดถูกตี)

ลายเซ็น:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

onValue (สอบถาม โทรกลับ ยกเลิกโทรกลับ)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onValue จะทริกเกอร์หนึ่งครั้งด้วยข้อมูลเริ่มต้นที่เก็บไว้ที่ตำแหน่งนี้จากนั้นทริกเกอร์อีกครั้งทุกครั้งที่ข้อมูลเปลี่ยนไป DataSnapshot ส่งผ่านไปยังการโทรกลับจะเป็นสถานที่ที่เรียก on() มันจะไม่ทริกเกอร์จนกว่าเนื้อหาทั้งหมดจะถูกซิงโครไนซ์ หากตำแหน่งไม่มีข้อมูลจะถูกทริกเกอร์ด้วย DataSnapshot ( val() จะถูกเรียก null ).

ลายเซ็น:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

OnValue (Query, Callback, Options)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onValue จะทริกเกอร์หนึ่งครั้งด้วยข้อมูลเริ่มต้นที่เก็บไว้ที่ตำแหน่งนี้จากนั้นทริกเกอร์อีกครั้งทุกครั้งที่ข้อมูลเปลี่ยนไป DataSnapshot ส่งผ่านไปยังการโทรกลับจะเป็นสถานที่ที่เรียก on() มันจะไม่ทริกเกอร์จนกว่าเนื้อหาทั้งหมดจะถูกซิงโครไนซ์ หากตำแหน่งไม่มีข้อมูลจะถูกทริกเกอร์ด้วย DataSnapshot ( val() จะถูกเรียก null ).

ลายเซ็น:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

ONVALUE (QUERY, CALLBACK, CANCELCALLBACK, ตัวเลือก)

รับฟังการเปลี่ยนแปลงข้อมูลในสถานที่เฉพาะ

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

เหตุการณ์ onValue จะทริกเกอร์หนึ่งครั้งด้วยข้อมูลเริ่มต้นที่เก็บไว้ที่ตำแหน่งนี้จากนั้นทริกเกอร์อีกครั้งทุกครั้งที่ข้อมูลเปลี่ยนไป DataSnapshot ส่งผ่านไปยังการโทรกลับจะเป็นสถานที่ที่เรียก on() มันจะไม่ทริกเกอร์จนกว่าเนื้อหาทั้งหมดจะถูกซิงโครไนซ์ หากตำแหน่งไม่มีข้อมูลจะถูกทริกเกอร์ด้วย DataSnapshot ( val() จะถูกเรียก null ).

ลายเซ็น:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

พารามิเตอร์

ผลตอบแทน:

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

ฟังก์ชั่นที่สามารถเรียกใช้เพื่อลบผู้ฟัง

แบบสอบถาม (Query, QueryConstraints)

สร้าง Query ที่ไม่เปลี่ยนรูปแบบใหม่ที่ขยายออกไปเพื่อรวมข้อ จำกัด การสืบค้นเพิ่มเติม

ลายเซ็น:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

พารามิเตอร์

ผลตอบแทน:

แบบสอบถาม

ข้อยกเว้น

หากข้อ จำกัด การสืบค้นใด ๆ ที่ให้ไว้ไม่สามารถรวมกับข้อ จำกัด ที่มีอยู่หรือใหม่ได้

ฟังก์ชั่น (อ้างอิง, ... )

onDisconnect(อ้างอิง)

ส่งคืนวัตถุ OnDisconnect - ดู การเปิดใช้งานความสามารถออฟไลน์ใน JavaScript สำหรับข้อมูลเพิ่มเติมเกี่ยวกับวิธีการใช้งาน

ลายเซ็น:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

พารามิเตอร์

ผลตอบแทน:

เปิดยกเลิกการเชื่อมต่อ

ลบ (อ้างอิง)

ลบข้อมูลที่ตำแหน่งฐานข้อมูลนี้

ข้อมูลใด ๆ ในตำแหน่งเด็กจะถูกลบ

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

ลายเซ็น:

export declare function remove(ref: DatabaseReference): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา<โมฆะ>

แก้ไขเมื่อลบบนเซิร์ฟเวอร์เสร็จสมบูรณ์

runTransaction(ref, transactionUpdate, options)

Atomically modifies the data at this location.

Atomically modify the data at this location. Unlike a normal set() , which just overwrites the data regardless of its previous value, runTransaction() is used to modify the existing value to a new value, ensuring there are no conflicts with other clients writing to the same location at the same time.

To accomplish this, you pass runTransaction() an update function which is used to transform the current value into a new value. If another client writes to the location before your new value is successfully written, your update function will be called again with the new current value, and the write will be retried. This will happen repeatedly until your write succeeds without conflict or you abort the transaction by not returning a value from your update function.

ลายเซ็น:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

พารามิเตอร์

ผลตอบแทน:

Promise< TransactionResult >

A Promise that can optionally be used instead of the onComplete callback to handle success and failure.

set(ref, value)

Writes data to this Database location.

This will overwrite any data at this location and all child locations.

The effect of the write will be visible immediately, and the corresponding events ("value", "child_added", etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Passing null for the new value is equivalent to calling remove() ; namely, all data at this location and all child locations will be deleted.

set() will remove any priority stored at this location, so if priority is meant to be preserved, you need to use setWithPriority() instead.

Note that modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and transaction() to modify the same data.

A single set() will generate a single "value" event at the location where the set() was performed.

ลายเซ็น:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา<โมฆะ>

Resolves when write to server is complete.

setPriority(ref, priority)

Sets a priority for the data at this Database location.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

ลายเซ็น:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา<โมฆะ>

Resolves when write to server is complete.

setWithPriority(ref, value, priority)

Writes data the Database location. Like set() but also specifies the priority for that data.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

ลายเซ็น:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา<โมฆะ>

Resolves when write to server is complete.

update(ref, values)

Writes multiple values to the Database at once.

The values argument contains multiple property-value pairs that will be written to the Database together. Each child property can either be a simple property (for example, "name") or a relative path (for example, "name/first") from the current location to the data to update.

As opposed to the set() method, update() can be use to selectively update only the referenced properties at the current location (instead of replacing all the child properties at the current location).

The effect of the write will be visible immediately, and the corresponding events ('value', 'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

A single update() will generate a single "value" event at the location where the update() was performed, regardless of how many children were modified.

Note that modifying data with update() will cancel any pending transactions at that location, so extreme care should be taken if mixing update() and transaction() to modify the same data.

Passing null to update() will remove the data at this location.

See Introducing multi-location updates and more .

ลายเซ็น:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

พารามิเตอร์

ผลตอบแทน:

สัญญา<โมฆะ>

Resolves when update on server is complete.

function(value, ...)

endAt(value, key)

Creates a QueryConstraint with the specified ending point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name less than or equal to the specified key.

You can read more about endAt() in Filtering data .

ลายเซ็น:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryConstraint

endBefore (ค่า, คีย์)

Creates a QueryConstraint with the specified ending point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value less than or equal to the specified value and a key name less than the specified key.

ลายเซ็น:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryConstraint

equalTo(value, key)

Creates a QueryConstraint that includes children that match the specified value.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have exactly the specified key as their key name. This can be used to filter result sets with many matches for the same value.

You can read more about equalTo() in Filtering data .

ลายเซ็น:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryConstraint

startAfter(value, key)

Creates a QueryConstraint with the specified starting point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is exclusive. If only a value is provided, children with a value greater than the specified value will be included in the query. If a key is specified, then children must have a value greater than or equal to the specified value and aa key name greater than the specified key.

ลายเซ็น:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryConstraint

startAt(value, key)

Creates a QueryConstraint with the specified starting point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.

You can read more about startAt() in Filtering data .

ลายเซ็น:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

พารามิเตอร์

ผลตอบแทน:

QueryConstraint

ประเภทเหตุการณ์

One of the following strings: "value", "child_added", "child_changed", "child_removed", or "child_moved."

ลายเซ็น:

export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';

QueryConstraintType

Describes the different query constraints available in this SDK.

ลายเซ็น:

export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';

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

A callback that can invoked to remove a listener.

ลายเซ็น:

export declare type Unsubscribe = () => void;