database.DataSnapshot class

ממשק המייצג תמונת מצב של נתונים של מסד נתונים של Firebase בזמן אמת.

חֲתִימָה:

export declare class DataSnapshot implements database.DataSnapshot 

מיישמת: database.DataSnapshot

בונים

בַּנַאִי משנה תיאור
(בנאי)(נתונים, נתיב, אפליקציה, מופע) בונה מופע חדש של המחלקה DataSnapshot

נכסים

תכונה משנה סוּג תיאור
למשל חוּט
מַפְתֵחַ מחרוזת | ריק המפתח (החלק האחרון של הנתיב) של המיקום של DataSnapshot זה. האסימון האחרון במיקום מסד נתונים נחשב למפתח שלו. לדוגמה, "ada" הוא המפתח עבור הצומת /users/ada/ . גישה למפתח בכל DataSnapshot מחזירה את המפתח עבור המיקום שיצר אותו. עם זאת, גישה למפתח בכתובת השורש של מסד נתונים מחזירה null .
ref מסד נתונים.הפניה מחזירה [ Reference ](/docs/reference/admin/node/admin.database.Reference) למיקום מסד הנתונים שבו התרחשה הכתיבה המפעילה. בעל גישת קריאה וכתיבה מלאה.

שיטות

שיטה משנה תיאור
child(childPath) מקבל DataSnapshot עבור המיקום בנתיב היחסי שצוין. הנתיב היחסי יכול להיות שם צאצא פשוט (לדוגמה, "ada") או נתיב עמוק יותר מופרד באלכסון (לדוגמה, "ada/name/first").
קיים() מחזירה true אם DataSnapshot זה מכיל נתונים כלשהם. זה מעט יותר יעיל משימוש snapshot.val() !== null . true אם DataSnapshot זו מכילה נתונים כלשהם; אחרת, false .
exportVal() מייצא את כל התוכן של DataSnapshot כאובייקט JavaScript. התוכן של DataSnapshot כערך JavaScript (אובייקט, מערך, מחרוזת, מספר, בוליאני או null ).
forEach(action) מונה את DataSnapshot של פריטי הילדים. בגלל האופן שבו אובייקטי JavaScript פועלים, לא מובטח שסדר הנתונים באובייקט ה-JavaScript המוחזר על ידי val() יתאים לסדר בשרת וגם לא לסדר של אירועי child_added . זה המקום שבו forEach() שימושי. זה מבטיח שהילדים של DataSnapshot יכולים להיות חוזרים לפי סדר השאילתות שלהם. אם לא נעשה שימוש בשיטת orderBy*() מפורשת, התוצאות מוחזרות לפי מפתח (אלא אם כן נעשה שימוש בסדרי עדיפויות, ובמקרה זה, התוצאות מוחזרות לפי עדיפות).
getPriority() מקבל את ערך העדיפות של הנתונים ב- DataSnapshot זה. כחלופה לשימוש בעדיפות, יישומים יכולים להזמין אוספים לפי מאפיינים רגילים. ראה [מיון וסינון נתונים](/docs/database/web/lists-of-data#sorting_and_filtering_data). ערך העדיפות של הנתונים.
hasChild(childPath) מחזירה true אם נתיב הצאצא שצוין מכיל נתונים (שאינם null ).
יש ילדים() מחזירה אם ל- DataSnapshot יש מאפייני צאצא שאינם null . אתה יכול להשתמש hasChildren() כדי לקבוע אם ל- DataSnapshot יש ילדים. אם כן, אתה יכול למנות אותם באמצעות forEach() . אם לא, אז תמונת מצב זו מכילה ערך פרימיטיבי (שניתן לאחזר באמצעות val() ) או שהיא ריקה (במקרה זה, val() מחזירה null ). true אם לתמונה הזו יש ילדים; אחרת false .
numChildren() מחזירה את מספר מאפייני הצאצא של DataSnapshot זה. מספר מאפייני הצאצא של DataSnapshot זה.
toJSON() מחזיר ייצוג ניתן להמשכה של JSON של אובייקט זה. ייצוג הניתן להמשכה של JSON של אובייקט זה.
val() מחלץ ערך JavaScript מ- DataSnapshot . בהתאם לנתונים ב- DataSnapshot , שיטת val() עשויה להחזיר סוג סקלרי (מחרוזת, מספר או בוליאני), מערך או אובייקט. זה עשוי גם להחזיר null , המציין ש- DataSnapshot ריק (לא מכיל נתונים). תוכן תמונת המצב כערך JavaScript (אובייקט, מערך, מחרוזת, מספר, בוליאני או null ).

database.DataSnapshot.(בנאי)

בונה מופע חדש של המחלקה DataSnapshot

חֲתִימָה:

constructor(data: any, path?: string, // path is undefined for the database root
    app?: App, instance?: string);

פרמטרים

פָּרָמֶטֶר סוּג תיאור
נתונים כל
נָתִיב חוּט
אפליקציה אפליקציה
למשל חוּט

database.DataSnapshot.instance

חֲתִימָה:

instance: string;

database.DataSnapshot.key

המפתח (החלק האחרון של הנתיב) של המיקום של DataSnapshot זה .

האסימון האחרון במיקום מסד נתונים נחשב למפתח שלו. לדוגמה, "ada" הוא המפתח עבור הצומת /users/ada/ . גישה למפתח בכל DataSnapshot מחזירה את המפתח עבור המיקום שיצר אותו. עם זאת, גישה למפתח בכתובת השורש של מסד נתונים מחזירה null .

חֲתִימָה:

get key(): string | null;

database.DataSnapshot.ref

מחזירה [ Reference ](/docs/reference/admin/node/admin.database.Reference) למיקום מסד הנתונים שבו התרחשה הכתיבה המפעילה. בעל גישת קריאה וכתיבה מלאה.

חֲתִימָה:

get ref(): database.Reference;

database.DataSnapshot.child()

מקבל DataSnapshot עבור המיקום בנתיב היחסי שצוין.

הנתיב היחסי יכול להיות שם צאצא פשוט (לדוגמה, "ada") או נתיב עמוק יותר מופרד באלכסון (לדוגמה, "ada/name/first").

חֲתִימָה:

child(childPath: string): DataSnapshot;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
נתיב ילד חוּט

החזרות:

תמונת נתונים

database.DataSnapshot.exists()

מחזירה true אם DataSnapshot זה מכיל נתונים כלשהם. זה מעט יותר יעיל משימוש snapshot.val() !== null .

true אם DataSnapshot זו מכילה נתונים כלשהם; אחרת, false .

חֲתִימָה:

exists(): boolean;

החזרות:

בוליאני

database.DataSnapshot.exportVal()

מייצא את כל התוכן של DataSnapshot כאובייקט JavaScript.

התוכן של DataSnapshot כערך JavaScript (אובייקט, מערך, מחרוזת, מספר, בוליאני או null ).

חֲתִימָה:

exportVal(): any;

החזרות:

כל

database.DataSnapshot.forEach()

מונה את DataSnapshot s של פריטי הילדים.

בגלל האופן שבו אובייקטי JavaScript פועלים, לא מובטח שסדר הנתונים באובייקט ה-JavaScript המוחזר על ידי val() יתאים לסדר בשרת וגם לא לסדר של אירועי child_added . זה המקום שבו forEach() שימושי. זה מבטיח שהילדים של DataSnapshot יכולים להיות חוזרים לפי סדר השאילתות שלהם.

אם לא נעשה שימוש בשיטת orderBy*() מפורשת, התוצאות מוחזרות לפי מפתח (אלא אם כן נעשה שימוש בסדרי עדיפויות, ובמקרה זה, התוצאות מוחזרות לפי עדיפות).

חֲתִימָה:

forEach(action: (a: DataSnapshot) => boolean | void): boolean;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
פעולה (ת: DataSnapshot ) => בוליאני | בָּטֵל פונקציה שנקראת עבור כל ילד DataSnapshot . ההתקשרות חזרה יכולה לחזור true כדי לבטל ספירה נוספת. true אם הספירה בוטלה עקב החזרת החזרה שלך true .

החזרות:

בוליאני

database.DataSnapshot.getPriority()

מקבל את ערך העדיפות של הנתונים ב- DataSnapshot זה .

כחלופה לשימוש בעדיפות, יישומים יכולים להזמין אוספים לפי מאפיינים רגילים. ראה [מיון וסינון נתונים](/docs/database/web/lists-of-data#sorting_and_filtering_data).

ערך העדיפות של הנתונים.

חֲתִימָה:

getPriority(): string | number | null;

החזרות:

מחרוזת | מספר | ריק

database.DataSnapshot.hasChild()

מחזירה true אם לנתיב הבן שצוין יש (non- null ) נתונים.

חֲתִימָה:

hasChild(childPath: string): boolean;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
נתיב ילד חוּט

החזרות:

בוליאני

database.DataSnapshot.hasChildren()

מחזירה אם ל- DataSnapshot יש מאפייני צאצא שאינם null .

אתה יכול להשתמש hasChildren() כדי לקבוע אם ל- DataSnapshot יש ילדים. אם כן, אתה יכול למנות אותם באמצעות forEach() . אם לא, אז גם תמונת המצב הזו מכילה ערך פרימיטיבי (שניתן לאחזר עם val() ) או שהוא ריק (במקרה זה, val() מחזירה null ).

true אם לתמונה הזו יש ילדים; אחרת false .

חֲתִימָה:

hasChildren(): boolean;

החזרות:

בוליאני

database.DataSnapshot.numChildren()

מחזירה את מספר מאפייני הצאצא של DataSnapshot זה .

מספר מאפייני הצאצא של DataSnapshot זה .

חֲתִימָה:

numChildren(): number;

החזרות:

מספר

database.DataSnapshot.toJSON()

מחזיר ייצוג ניתן להמשכה של JSON של אובייקט זה.

ייצוג הניתן להמשכה של JSON של אובייקט זה.

חֲתִימָה:

toJSON(): Record<string, unknown>;

החזרות:

הקלט<מחרוזת, לא ידוע>

database.DataSnapshot.val()

מחלץ ערך JavaScript מ- DataSnapshot .

תלוי בנתונים ב- DataSnapshot , שיטת val() עשויה להחזיר סוג סקלארי (מחרוזת, מספר או בוליאני), מערך או אובייקט. זה גם עשוי להחזיר null , המציין ש- DataSnapshot ריק (לא מכיל נתונים).

תוכן תמונת המצב כערך JavaScript (אובייקט, מערך, מחרוזת, מספר, בוליאני או null ).

חֲתִימָה:

val(): any;

החזרות:

כל