@firebase/firestore/lite

פונקציות

שיעורים

ממשקים

הקלד כינויים

פונקציה (אפליקציה,...)

getFirestore(אפליקציה)

מחזירה את מופע ברירת המחדל הקיים של Firestore המשויך ל- FirebaseApp שסופק . אם לא קיים מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.

חֲתִימָה:

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

פרמטרים

החזרות:

Firestore

מופע Firestore של האפליקציה שסופקה.

getFirestore(app, databaseId)

ממשק API זה מסופק כתצוגה מקדימה למפתחים ועשוי להשתנות בהתאם למשוב שנקבל. אל תשתמש ב-API זה בסביבת ייצור.

מחזירה את מופע Firestore הקיים המשויך ל- FirebaseApp שסופק . אם לא קיים מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.

חֲתִימָה:

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

פרמטרים

החזרות:

Firestore

מופע Firestore של האפליקציה שסופקה.

אתחולFirestore (אפליקציה, הגדרות)

מאתחל מופע חדש של Cloud Firestore עם ההגדרות שסופקו. ניתן לקרוא רק לפני כל פונקציה אחרת, כולל getFirestore() . אם ההגדרות המותאמות אישית ריקות, פונקציה זו שווה ערך לקריאה getFirestore() .

חֲתִימָה:

export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;

פרמטרים

החזרות:

Firestore

מופע Firestore שאותחל לאחרונה.

initializeFirestore(אפליקציה, הגדרות, זיהוי מסד נתונים)

ממשק API זה מסופק כתצוגה מקדימה למפתחים ועשוי להשתנות בהתאם למשוב שנקבל. אל תשתמש ב-API זה בסביבת ייצור.

מאתחל מופע חדש של Cloud Firestore עם ההגדרות שסופקו. ניתן לקרוא רק לפני כל פונקציה אחרת, כולל getFirestore() . אם ההגדרות המותאמות אישית ריקות, פונקציה זו שווה ערך לקריאה getFirestore() .

חֲתִימָה:

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

פרמטרים

החזרות:

Firestore

מופע Firestore שאותחל לאחרונה.

פונקציה (firestore, ...)

אוסף (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, host, port, options)

שנה מופע זה כדי לתקשר עם אמולטור Cloud Firestore.

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

doc(firestore, path, pathSegments)

מקבל מופע DocumentReference המתייחס למסמך בנתיב המוחלט שצוין.

חֲתִימָה:

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

פרמטרים

החזרות:

הפניה למסמך < DocumentData , DocumentData >

מופע DocumentReference .

חריגים

אם לנתיב הסופי יש מספר אי זוגי של קטעים ואינו מצביע על מסמך.

runTransaction (firestore, updateFunction, options)

מבצע את 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 מוחזר לכאן. אחרת, אם העסקה נכשלה, מוחזרת הבטחה שנדחתה עם שגיאת הכשל המתאימה.

terminate (firestore)

מסיים את מופע Firestore שסופק.

לאחר קריאה ל- terminate() ניתן להשתמש רק בפונקציות clearIndexedDbPersistence() . כל פונקציה אחרת תזרוק FirestoreError . סיום אינו מבטל כתיבה ממתינה וכל הבטחה הממתינה לתגובה מהשרת לא תיפתרנה.

כדי להפעיל מחדש לאחר סיום, צור מופע חדש של Firestore עם getFirestore() .

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה<void>

Promise שנפתרת כאשר המופע נסגר בהצלחה.

writeBatch(firestore)

יוצר אצווה כתיבה, המשמשת לביצוע כתיבה מרובת כפעולה אטומית אחת. המספר המרבי של כתיבה המותר ב-WriteBatch בודד הוא 500.

התוצאה של כתיבה אלו תבוא לידי ביטוי רק בקריאות מסמכים המתרחשות לאחר שההבטחה שהוחזרה תיפתר. אם הלקוח לא מקוון, הכתיבה נכשלת. אם תרצה לראות שינויים מקומיים או כתיבת חוצץ עד שהלקוח יהיה מקוון, השתמש ב-SDK המלא של Firestore.

חֲתִימָה:

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

פרמטרים

החזרות:

WriteBatch

WriteBatch שניתן להשתמש בו כדי לבצע כתיבה אטומית.

פוּנקצִיָה()

לספור()

צור אובייקט AggregateField שניתן להשתמש בו כדי לחשב את ספירת המסמכים בערכת התוצאות של שאילתה.

חֲתִימָה:

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

החזרות:

שדה מצטבר <מספר>

deleteField()

מחזירה זקיף לשימוש עם updateDoc() או setDoc() עם {merge: true} כדי לסמן שדה למחיקה.

חֲתִימָה:

export declare function deleteField(): FieldValue;

החזרות:

FieldValue

documentId()

מחזירה FieldPath מיוחד להתייחסות למזהה של מסמך. ניתן להשתמש בו בשאילתות כדי למיין או לסנן לפי מזהה המסמך.

חֲתִימָה:

export declare function documentId(): FieldPath;

החזרות:

FieldPath

getFirestore()

מחזירה את מופע ברירת המחדל הקיים של Firestore המשויך ל- FirebaseApp המוגדר כברירת מחדל . אם לא קיים מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.

חֲתִימָה:

export declare function getFirestore(): Firestore;

החזרות:

Firestore

מופע Firestore של האפליקציה שסופקה.

serverTimestamp()

מחזירה זקיף המשמש עם setDoc() או updateDoc() כדי לכלול חותמת זמן שנוצרת על ידי שרת בנתונים הכתובים.

חֲתִימָה:

export declare function serverTimestamp(): FieldValue;

החזרות:

FieldValue

function(databaseId, ...)

getFirestore(databaseId)

ממשק API זה מסופק כתצוגה מקדימה למפתחים ועשוי להשתנות בהתאם למשוב שנקבל. אל תשתמש ב-API זה בסביבת ייצור.

מחזירה את המופע הקיים של Firestore המשויך ל- FirebaseApp המוגדר כברירת מחדל . אם לא קיים מופע, מאתחל מופע חדש עם הגדרות ברירת מחדל.

חֲתִימָה:

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

פרמטרים

החזרות:

Firestore

מופע Firestore של האפליקציה שסופקה.

פונקציה (אלמנטים, ...)

arrayRemove(elements)

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

חֲתִימָה:

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

פרמטרים

החזרות:

FieldValue

זקיף FieldValue לשימוש בקריאה ל- setDoc() או updateDoc()

arrayUnion(אלמנטים)

מחזירה ערך מיוחד שניתן להשתמש בו עם setDoc() או updateDoc() שאומר לשרת לאחד את האלמנטים הנתונים עם כל ערך מערך שכבר קיים בשרת. כל אלמנט שצוין שלא קיים כבר במערך יתווסף לסוף. אם השדה המשתנה אינו כבר מערך, הוא ידרוס במערך המכיל בדיוק את האלמנטים שצוינו.

חֲתִימָה:

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

פרמטרים

החזרות:

FieldValue

זקיף FieldValue לשימוש בקריאה ל- setDoc() או updateDoc() .

פונקציה (שדה,...)

ממוצע (שדה)

צור אובייקט AggregateField שניתן להשתמש בו כדי לחשב את הממוצע של שדה שצוין על פני טווח של מסמכים בערכת התוצאות של שאילתה.

חֲתִימָה:

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

פרמטרים

החזרות:

שדה מצטבר <מספר | null>

sum(field)

צור אובייקט AggregateField שניתן להשתמש בו כדי לחשב את הסכום של שדה שצוין על פני טווח של מסמכים בערכת התוצאות של שאילתה.

חֲתִימָה:

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

פרמטרים

החזרות:

שדה מצטבר <מספר>

function(fieldPath, ...)

orderBy(fieldPath, directionStr)

יוצר QueryOrderByConstraint הממיין את תוצאת השאילתה לפי השדה שצוין, אופציונלי בסדר יורד במקום עולה.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryOrderByConstraint

ה- QueryOrderByConstraint שנוצר .

where(fieldPath, opStr, value)

יוצר QueryFieldFilterConstraint האוכפת שמסמכים חייבים להכיל את השדה שצוין ושהערך צריך לעמוד באילוץ היחס שסופק.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryFieldFilterConstraint

QueryFieldFilterConstraint שנוצר .

function(fieldValues, ...)

endAt(fieldValues)

יוצר QueryEndAtConstraint שמשנה את ערכת התוצאה כך שתסתיים בשדות שסופקו ביחס לסדר השאילתה. סדר ערכי השדות חייב להתאים לסדר הסדר לפי סעיפים של השאילתה.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryEndAtConstraint

QueryEndAtConstraint להעביר ל- query()

endBefore(fieldValues)

יוצר QueryEndAtConstraint שמשנה את התוצאה שתסתיים לפני השדות שסופקו ביחס לסדר השאילתה. סדר ערכי השדות חייב להתאים לסדר הסדר לפי סעיפים של השאילתה.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryEndAtConstraint

QueryEndAtConstraint להעביר ל- query()

startAfter(fieldValues)

יוצר QueryStartAtConstraint שמשנה את ערכת התוצאה להתחיל אחרי השדות שסופקו ביחס לסדר השאילתה. סדר ערכי השדות חייב להתאים לסדר הסדר לפי סעיפים של השאילתה.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryStartAtConstraint

QueryStartAtConstraint להעביר ל- query()

startAt(fieldValues)

יוצר QueryStartAtConstraint שמשנה את ערכת התוצאה כך שתתחיל בשדות שסופקו ביחס לסדר השאילתה. סדר ערכי השדות חייב להתאים לסדר הסדר לפי סעיפים של השאילתה.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryStartAtConstraint

QueryStartAtConstraint להעביר ל- query() .

פונקציה (שמאל,...)

aggregateFieldEqual(שמאל, ימין)

משווה שני 'AggregateField `מקרים לשוויון.

חֲתִימָה:

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

פרמטרים

החזרות:

בוליאני

aggregateQuerySnapshotEqual(שמאל, ימין)

משווה בין שני מופעי AggregateQuerySnapshot לצורך שוויון.

שני מופעי AggregateQuerySnapshot נחשבים "שווים" אם יש להם שאילתות בסיסיות המשוות שוות, ואותם נתונים.

חֲתִימָה:

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

פרמטרים

החזרות:

בוליאני

true אם האובייקטים "שווים", כפי שהוגדרו לעיל, או false אחרת.

queryEqual(שמאל, ימין)

מחזירה true אם השאילתות שסופקו מצביעות על אותו אוסף ומחילות את אותם אילוצים.

חֲתִימָה:

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

פרמטרים

החזרות:

בוליאני

true אם ההפניות מצביעות על אותו מיקום באותו מסד נתונים של Firestore.

refEqual(שמאל, ימין)

מחזירה true אם ההפניות שסופקו שוות.

חֲתִימָה:

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

פרמטרים

החזרות:

בוליאני

true אם ההפניות מצביעות על אותו מיקום באותו מסד נתונים של Firestore.

snapshotEqual(שמאל, ימין)

מחזירה אמת אם התמונות שסופקו שוות.

חֲתִימָה:

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

פרמטרים

החזרות:

בוליאני

נכון אם התמונות שוות.

פונקציה (מגבלה,...)

limit (limit)

יוצר QueryLimitConstraint שמחזיר רק את המסמכים התואמים הראשונים.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryLimitConstraint

ה- QueryLimitConstraint שנוצר .

limitToLast(limit)

יוצר QueryLimitConstraint שמחזיר רק את המסמכים התואמים האחרונים.

עליך לציין לפחות סעיף orderBy אחד עבור שאילתות limitToLast , אחרת ייגרם חריג במהלך הביצוע.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryLimitConstraint

ה- QueryLimitConstraint שנוצר .

function(logLevel, ...)

setLogLevel(logLevel)

מגדיר את המילוליות של יומני Cloud Firestore (ניפוי באגים, שגיאה או שקט).

חֲתִימָה:

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

פרמטרים

החזרות:

בָּטֵל

function(n,...)

תוספת (n)

מחזירה ערך מיוחד שניתן להשתמש בו עם setDoc() או updateDoc() שאומר לשרת להגדיל את הערך הנוכחי של השדה בערך הנתון.

אם אופרנד או ערך השדה הנוכחי משתמשים בדיוק בנקודה צפה, כל האריתמטיקה עוקבת אחר סמנטיקה של IEEE 754. אם שני הערכים הם מספרים שלמים, ערכים מחוץ לטווח המספרים הבטוח של JavaScript ( Number.MIN_SAFE_INTEGER עד Number.MAX_SAFE_INTEGER ) נתונים גם לאובדן דיוק. יתר על כן, לאחר עיבוד על ידי הקצה האחורי של Firestore, כל פעולות המספרים השלמים מוגבלות בין -2^63 ל-2^63-1.

אם ערך השדה הנוכחי אינו מסוג number , או אם השדה עדיין לא קיים, הטרנספורמציה מגדירה את השדה לערך הנתון.

חֲתִימָה:

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

פרמטרים

החזרות:

FieldValue

זקיף FieldValue לשימוש בקריאה ל- setDoc() או updateDoc()

פונקציה (שאילתה,...)

getAggregate(שאילתה, aggregateSpec)

מחשב את הצבירות שצוינו על המסמכים בערכת התוצאות של השאילתה הנתונה מבלי להוריד בפועל את המסמכים.

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

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

דוגמא

const aggregateSnapshot = await getAggregate(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;

getCount(שאילתה)

מחשב את מספר המסמכים בערכת התוצאות של השאילתה הנתונה מבלי להוריד בפועל את המסמכים.

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

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה< AggregateQuerySnapshot <{ ספירה: AggregateField <מספר>; }, AppModelType, DbModelType>>

הבטחה שתיפתר עם הספירה; ניתן לאחזר את הספירה מ- snapshot.data().count , כאשר snapshot היא ה- AggregateQuerySnapshot שאליה נפתרת ההבטחה המוחזרת.

getDocs(שאילתה)

מבצע את השאילתה ומחזיר את התוצאות כ- QuerySnapshot .

כל השאילתות מבוצעות ישירות על ידי השרת, גם אם השאילתה בוצעה בעבר. שינויים אחרונים באים לידי ביטוי בתוצאות שאוחזרו רק אם הם כבר יושמו על ידי הקצה העורפי. אם הלקוח לא מקוון, הפעולה נכשלת. כדי לראות תוצאות שנשמרו בעבר במטמון ושינויים מקומיים, השתמש ב-SDK המלא של Firestore.

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה< QuerySnapshot <AppModelType, DbModelType>>

הבטחה שתיפתר עם תוצאות השאילתה.

query(query, compositeFilter, queryConstraints)

יוצר מופע חדש בלתי ניתן לשינוי של שאילתה שמתרחב כך שיכלול גם אילוצי שאילתה נוספים.

חֲתִימָה:

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

פרמטרים

החזרות:

שאילתא <AppModelType, DbModelType>

חריגים

אם לא ניתן לשלב אחד מאילוצי השאילתה שסופקו עם האילוצים הקיימים או החדשים.

query(query, queryConstraints)

יוצר מופע חדש בלתי ניתן לשינוי של שאילתה שמתרחב כך שיכלול גם אילוצי שאילתה נוספים.

חֲתִימָה:

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

פרמטרים

החזרות:

שאילתא <AppModelType, DbModelType>

חריגים

אם לא ניתן לשלב אחד מאילוצי השאילתה שסופקו עם האילוצים הקיימים או החדשים.

function(queryConstraints, ...)

and(queryConstraints)

יוצר QueryCompositeFilterConstraint חדש שהוא שילוב של אילוצי המסנן הנתונים. מסנן צירוף כולל מסמך אם הוא עומד בכל המסננים הנתונים.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryCompositeFilterConstraint

ה- QueryCompositeFilterConstraint החדש שנוצר .

or(queryConstraints)

יוצר QueryCompositeFilterConstraint חדש המהווה ניתוק של אילוצי המסנן הנתונים. מסנן ניתוק כולל מסמך אם הוא עומד באחד מהמסננים הנתונים.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryCompositeFilterConstraint

ה- QueryCompositeFilterConstraint החדש שנוצר .

פונקציה (הפניה, ...)

addDoc(הפניה, נתונים)

הוסף מסמך חדש ל- CollectionReference שצוין עם הנתונים הנתונים, הקצה לו מזהה מסמך באופן אוטומטי.

התוצאה של כתיבה זו תבוא לידי ביטוי רק בקריאות מסמכים שיתרחשו לאחר שההבטחה שהוחזרה תיפתר. אם הלקוח לא מקוון, הכתיבה נכשלת. אם תרצה לראות שינויים מקומיים או כתיבת חוצץ עד שהלקוח יהיה מקוון, השתמש ב-SDK המלא של Firestore.

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה< DocumentReference <AppModelType, DbModelType>>

Promise נפתרה עם DocumentReference המצביע על המסמך החדש שנוצר לאחר שנכתב ל-backend.

חריגים

שגיאה - אם הקלט שסופק אינו מסמך Firestore חוקי.

אוסף (הפניה, נתיב, נתיבSegments)

מקבל מופע CollectionReference המתייחס לתת-אוסף של reference בנתיב היחסי שצוין.

חֲתִימָה:

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

פרמטרים

החזרות:

הפניה לאוסף < DocumentData , DocumentData >

מופע CollectionReference .

חריגים

אם הנתיב הסופי כולל מספר זוגי של קטעים ואינו מצביע על אוסף.

אוסף (הפניה, נתיב, נתיבSegments)

מקבל מופע CollectionReference המתייחס לתת-אוסף של reference בנתיב היחסי שצוין.

חֲתִימָה:

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

פרמטרים

החזרות:

הפניה לאוסף < DocumentData , DocumentData >

מופע CollectionReference .

חריגים

אם הנתיב הסופי כולל מספר זוגי של קטעים ואינו מצביע על אוסף.

deleteDoc (הפניה)

מוחק את המסמך שאליו מתייחס DocumentReference שצוין .

המחיקה תבוא לידי ביטוי רק בקריאות מסמכים שיתרחשו לאחר שההבטחה שהוחזרה תיפתר. אם הלקוח לא מקוון, המחיקה נכשלת. אם תרצה לראות שינויים מקומיים או כתיבת חוצץ עד שהלקוח יהיה מקוון, השתמש ב-SDK המלא של Firestore.

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה<void>

Promise נפתרה לאחר שהמסמך נמחק בהצלחה מהקצה האחורי.

doc(reference, path, pathSegments)

מקבל מופע DocumentReference המתייחס למסמך בתוך reference בנתיב היחסי שצוין. אם לא צוין נתיב, מזהה ייחודי שנוצר אוטומטית ישמש עבור DocumentReference המוחזר .

חֲתִימָה:

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

פרמטרים

החזרות:

הפניה למסמך <AppModelType, DbModelType>

מופע DocumentReference .

חריגים

אם לנתיב הסופי יש מספר אי זוגי של קטעים ואינו מצביע על מסמך.

doc(reference, path, pathSegments)

מקבל מופע DocumentReference המתייחס למסמך בתוך reference בנתיב היחסי שצוין.

חֲתִימָה:

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

פרמטרים

החזרות:

הפניה למסמך < DocumentData , DocumentData >

מופע DocumentReference .

חריגים

אם לנתיב הסופי יש מספר אי זוגי של קטעים ואינו מצביע על מסמך.

getDoc (הפניה)

קורא את המסמך שאליו מתייחס המסמך שצוין.

כל המסמכים נשלפים ישירות מהשרת, גם אם המסמך נקרא או שונה בעבר. שינויים אחרונים משתקפים בתמונת ה- DocumentSnapshot שאוחזרו רק אם הם כבר הוחלו על ידי הקצה העורפי. אם הלקוח לא מקוון, הקריאה נכשלת. אם אתה רוצה להשתמש במטמון או לראות שינויים מקומיים, אנא השתמש ב-SDK המלא של Firestore.

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה< DocumentSnapshot <AppModelType, DbModelType>>

הבטחה נפתרה עם תצלום של DocumentSnapshot המכילה את תוכן המסמך הנוכחי.

setDoc(הפניה, נתונים)

כותב למסמך שאליו מתייחס DocumentReference שצוין . אם המסמך עדיין לא קיים, הוא ייווצר.

התוצאה של כתיבה זו תבוא לידי ביטוי רק בקריאות מסמכים שיתרחשו לאחר שההבטחה שהוחזרה תיפתר. אם הלקוח לא מקוון, הכתיבה נכשלת. אם תרצה לראות שינויים מקומיים או כתיבת חוצץ עד שהלקוח יהיה מקוון, השתמש ב-SDK המלא של Firestore.

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה<void>

Promise נפתרה ברגע שהנתונים נכתבו בהצלחה ל-backend.

חריגים

שגיאה - אם הקלט שסופק אינו מסמך Firestore חוקי.

setDoc(הפניה, נתונים, אפשרויות)

כותב למסמך שאליו מתייחס DocumentReference שצוין . אם המסמך עדיין לא קיים, הוא ייווצר. אם אתה מספק merge או mergeFields , ניתן למזג את הנתונים שסופקו למסמך קיים.

התוצאה של כתיבה זו תבוא לידי ביטוי רק בקריאות מסמכים שיתרחשו לאחר שההבטחה שהוחזרה תיפתר. אם הלקוח לא מקוון, הכתיבה נכשלת. אם תרצה לראות שינויים מקומיים או כתיבת חוצץ עד שהלקוח יהיה מקוון, השתמש ב-SDK המלא של Firestore.

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה<void>

Promise נפתרה ברגע שהנתונים נכתבו בהצלחה ל-backend.

חריגים

שגיאה - אם הקלט שסופק אינו מסמך Firestore חוקי.

updateDoc(הפניה, נתונים)

מעדכן שדות במסמך שאליו מתייחס DocumentReference שצוין . העדכון ייכשל אם יוחל על מסמך שאינו קיים.

התוצאה של עדכון זה תבוא לידי ביטוי רק בקריאות מסמכים המתרחשות לאחר פתרון ההבטחה שהוחזרה. אם הלקוח לא מקוון, העדכון נכשל. אם תרצה לראות שינויים מקומיים או כתיבת חוצץ עד שהלקוח יהיה מקוון, השתמש ב-SDK המלא של Firestore.

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה<void>

Promise נפתרה ברגע שהנתונים נכתבו בהצלחה ל-backend.

חריגים

שגיאה - אם הקלט שסופק אינו נתוני Firestore חוקיים.

updateDoc(reference, field, value, moreFieldsAndValues)

עדכון שדות במסמך שאליו מתייחס DocumentReference שצוין העדכון ייכשל אם יוחל על מסמך שאינו קיים.

ניתן לעדכן שדות מקוננים על ידי מתן מחרוזות נתיב שדות מופרדות בנקודות או על ידי אספקת אובייקטי FieldPath .

התוצאה של עדכון זה תבוא לידי ביטוי רק בקריאות מסמכים המתרחשות לאחר פתרון ההבטחה שהוחזרה. אם הלקוח לא מקוון, העדכון נכשל. אם תרצה לראות שינויים מקומיים או כתיבת חוצץ עד שהלקוח יהיה מקוון, השתמש ב-SDK המלא של Firestore.

חֲתִימָה:

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

פרמטרים

החזרות:

הבטחה<void>

Promise נפתרה ברגע שהנתונים נכתבו בהצלחה ל-backend.

חריגים

שגיאה - אם הקלט שסופק אינו נתוני Firestore חוקיים.

פונקציה (תמונת מצב, ...)

endAt(תמונה)

יוצר QueryEndAtConstraint שמשנה את ערכת התוצאה כך שתסתיים במסמך שסופק (כולל). מיקום הקצה הוא יחסית לסדר השאילתה. המסמך חייב להכיל את כל השדות שסופקו בסדר לפי השאילתה.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryEndAtConstraint

QueryEndAtConstraint להעביר ל- query()

endBefore(תמונה)

יוצר QueryEndAtConstraint שמשנה את התוצאה שתסתיים לפני המסמך שסופק (בלעדי). מיקום הקצה הוא יחסית לסדר השאילתה. המסמך חייב להכיל את כל השדות שסופקו בסדר לפי השאילתה.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryEndAtConstraint

QueryEndAtConstraint להעביר ל- query()

startAfter (תמונה)

יוצר QueryStartAtConstraint שמשנה את ערכת התוצאה להתחיל אחרי המסמך שסופק (בלעדי). מיקום ההתחלה הוא יחסית לסדר השאילתה. המסמך חייב להכיל את כל השדות שסופקו בסדר לפי השאילתה.

חֲתִימָה:

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

פרמטרים

החזרות:

QueryStartAtConstraint

QueryStartAtConstraint להעביר ל- query()

startAt(תמונה)

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

חֲתִימָה:

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

פרמטרים

החזרות:

QueryStartAtConstraint

QueryStartAtConstraint להעביר ל- query() .

AddPrefixToKeys

מחזירה מפה חדשה שבה כל מפתח מלווה במקש החיצוני מצורף לנקודה.

חֲתִימָה:

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

האיחוד של כל סוגי AggregateField הנתמכים על ידי Firestore.

חֲתִימָה:

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

מצרפי מפרט נתונים

סוג שהמפתחות שלו לקוחים מ- AggregateSpec , ואשר ערכיו הם תוצאה של הצבירה שבוצעה על ידי AggregateField המקביל מהקלט AggregateSpec .

חֲתִימָה:

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

AggregateType

סוג איחוד המייצג את הסוג המצטבר שיש לבצע.

חֲתִימָה:

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

ChildUpdateFields

עוזר לחישוב השדות המקוננים עבור סוג נתון T1. זה נחוץ כדי להפיץ סוגי איגוד כגון undefined | {...} (קורה עבור אביזרים אופציונליים) או {a: A} | {b: B} .

במקרה שימוש זה, נעשה שימוש V כדי להפיץ את סוגי האיחוד של T[K] Record , שכן T[K] מוערך כביטוי ולא מופץ.

ראה 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;

FirestoreErrorCode

קבוצת קודי המצב של Firestore. הקודים זהים לאלו שנחשפו על ידי gRPC כאן: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

ערכים אפשריים: - 'מבוטל': הפעולה בוטלה (בדרך כלל על ידי המתקשר). - 'לא ידוע': שגיאה לא ידועה או שגיאה מתחום שגיאה אחר. - 'invalid-argument': הלקוח ציין ארגומנט לא חוקי. שימו לב שזה שונה מ'תנאי מוקדם' שנכשל. 'invalid-argument' מציין ארגומנטים שהם בעייתיים ללא קשר למצב המערכת (למשל שם שדה לא חוקי). - 'חורג מהמועד האחרון': פג תוקף לפני שהפעולה הסתיימה. עבור פעולות שמשנות את מצב המערכת, שגיאה זו עשויה להיות מוחזרת גם אם הפעולה הושלמה בהצלחה. לדוגמה, תגובה מוצלחת משרת יכולה הייתה להתעכב מספיק זמן כדי שהמועד האחרון יפוג. - 'לא נמצא': חלק מהמסמך המבוקש לא נמצא. - 'כבר-קיים': מסמך כלשהו שניסינו ליצור כבר קיים. - 'הרשאה נדחתה': למתקשר אין הרשאה לבצע את הפעולה שצוינה. - 'המשאב מוצת': משאב מסוים מוצה, אולי מכסה לכל משתמש, או אולי כל מערכת הקבצים נגמרה. - 'failed-precondition': הפעולה נדחתה מכיוון שהמערכת אינה במצב הנדרש לביצוע הפעולה. - 'בוטלה': הפעולה בוטלה, בדרך כלל עקב בעיית בו-זמנית כמו ביטול עסקה וכו'. - 'מחוץ לטווח': הפעולה נוסתה מעבר לטווח החוקי. - 'לא מיושם': הפעולה אינה מיושמת או אינה נתמכת/מופעלת. - 'פנימי': שגיאות פנימיות. פירוש הדבר שחלק מהאינווריאציות הצפויות על ידי המערכת הבסיסית נשברו. אם אתה רואה אחת מהשגיאות האלה, משהו מאוד שבור. - 'לא זמין': השירות אינו זמין כעת. זה ככל הנראה מצב חולף וניתן לתקן אותו על ידי ניסיון חוזר עם ביטול. - 'אובדן נתונים': אובדן נתונים או שחיתות בלתי ניתן לשחזור. - 'לא מאומת': לבקשה אין אישורי אימות חוקיים עבור הפעולה.

חֲתִימָה:

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';

NestedUpdateFields

עבור כל שדה (למשל 'סרגל'), מצא את כל המפתחות המקננים (למשל { 'bar.baz': T1, 'bar.qux': T2 } ). צלב אותם יחד כדי ליצור מפה אחת המכילה את כל המפתחות האפשריים שכולם מסומנים כאופציונליים

חֲתִימָה:

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

OrderByDirection

הכיוון של משפט orderBy() מצוין כ-'desc' או 'asc' (יורד או עולה).

חֲתִימָה:

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

PartialWithFieldValue

בדומה ל Partial<T> של Typescript , אך מאפשר השמטת שדות מקוננים והעברת FieldValues ​​בתור ערכי מאפיינים.

חֲתִימָה:

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

פְּרִימִיטִיבִי

טיפוסים פרימיטיביים.

חֲתִימָה:

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

QueryConstraintType

מתאר את אילוצי השאילתה השונים הזמינים ב-SDK זה.

חֲתִימָה:

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

QueryFilterConstraint

QueryFilterConstraint הוא סוג איחוד עוזר המייצג את QueryFieldFilterConstraint ו- QueryCompositeFilterConstraint .

חֲתִימָה:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint הוא סוג איחוד עוזר המייצג QueryConstraints המשמשים לצמצום או לסדר את קבוצת המסמכים, אך אינם מסננים במפורש בשדה מסמך. QueryNonFilterConstraint s נוצרים על ידי הפעלת orderBy() , מתחיל ב() , startAfter() , endBefore() , נגמר ב() , limit() או limitToLast() ולאחר מכן ניתן להעביר אותם אל query() כדי ליצור מופע שאילתה חדש המכיל גם את QueryConstraint .

חֲתִימָה:

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

הגדר אפשרויות

אובייקט אפשרויות המגדיר את ההתנהגות של setDoc() , ושיחות. ניתן להגדיר שיחות אלו לביצוע מיזוגים פרטניים במקום לדרוס את מסמכי היעד בשלמותם על ידי מתן SetOptions עם merge: true .

חֲתִימָה:

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

UnionToIntersection

בהינתן סוג איחוד U = T1 | T2 | ... , מחזירה סוג נחתך (T1 & T2 & ...) .

משתמש בסוגים מותנים חלוקתיים ובהסקת טיפוסים מותנים. זה עובד מכיוון שמספר רב של מועמדים עבור אותו משתנה מסוג במיקומים נגד וריאנטים גורם להסקת סוג צומת. 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;

עדכן מידע

עדכון נתונים (לשימוש עם updateDoc() ) המורכב מנתיבי שדות (למשל 'foo' או 'foo.baz') ממופים לערכים. שדות המכילים נקודות מפנים לשדות מקוננים בתוך המסמך. ניתן להעביר ערכי Field כערכי מאפיינים.

חֲתִימָה:

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

WhereFilterOp

תנאי סינון בפסקת where() מצוינים באמצעות המחרוזות '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains' , 'in', 'array-contains-any' ו-'not-in'.

חֲתִימָה:

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

WithFieldValue

מאפשר להעביר FieldValues ​​כערך מאפיין תוך שמירה על בטיחות הסוג.

חֲתִימָה:

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