storage package

אחסון בענן עבור Firebase

פונקציות

פוּנקצִיָה תיאור
פונקציה (אפליקציה,...)
getStorage(app, bucketUrl) מקבל מופע FirebaseStorage עבור אפליקציית Firebase הנתונה.
פונקציה (אחסון,...)
connectStorageEmulator (אחסון, מארח, יציאה, אפשרויות) שנה מופע FirebaseStorage זה כדי לתקשר עם אמולטור Cloud Storage.
ref(אחסון, כתובת אתר) מחזירה StorageReference עבור כתובת האתר הנתונה.
function (ref, ...)
deleteObject(ref) מוחק את האובייקט במיקום זה.
getBlob(ref, maxDownloadSizeBytes) מוריד את הנתונים במיקום האובייקט. מחזירה שגיאה אם ​​האובייקט לא נמצא. כדי להשתמש בפונקציונליות זו, עליך לרשום את מקור האפליקציה שלך ברשימת ההיתרים בדלי של Cloud Storage. ראה גם https://cloud.google.com/storage/docs/configuring-cors ממשק API זה אינו זמין ב-Node.
getBytes(ref, maxDownloadSizeBytes) מוריד את הנתונים במיקום האובייקט. מחזירה שגיאה אם ​​האובייקט לא נמצא. כדי להשתמש בפונקציונליות זו, עליך לרשום את מקור האפליקציה שלך ברשימת ההיתרים בדלי של Cloud Storage. ראה גם https://cloud.google.com/storage/docs/configuring-cors
getDownloadURL(ref) מחזירה את כתובת האתר להורדה עבור StorageReference הנתון .
getMetadata(ref) Promise שנפתרת עם המטא נתונים עבור אובייקט זה. אם אובייקט זה אינו קיים או שלא ניתן לאחזר מטא נתונים, ההבטחה נדחית.
getStream(ref, maxDownloadSizeBytes) מוריד את הנתונים במיקום האובייקט. מעלה אירוע שגיאה אם ​​האובייקט לא נמצא. ממשק API זה זמין רק ב-Node.
רשימה (ר', אפשרויות) רשום פריטים (קבצים) וקידומות (תיקיות) תחת הפניה זו לאחסון. רשימה API זמין רק עבור Firebase Rules גרסה 2. GCS היא חנות מפתחות. Firebase Storage כופה את הסמנטיקה של מבנה התיקיות המופרד '/'. עיין ב- List API של GCS אם ברצונך ללמוד עוד. כדי לציית לסמנטיקה של Firebase Rules, Firebase Storage אינו תומך באובייקטים שהנתיבים שלהם מסתיימים ב-"/" או מכילים שני "/" עוקבים. Firebase Storage List API יסנן את האובייקטים הלא נתמכים האלה. list() עלול להיכשל אם יש יותר מדי אובייקטים לא נתמכים בדלי.
listAll(ref) רשום את כל הפריטים (קבצים) וקידומות (תיקיות) תחת הפניה זו לאחסון. זוהי שיטת עוזר לקריאה ל-list() שוב ושוב עד שאין יותר תוצאות. גודל העימוד המוגדר כברירת מחדל הוא 1000. הערה: ייתכן שהתוצאות לא יהיו עקביות אם אובייקטים משתנים בזמן שהפעולה הזו פועלת. אזהרה: listAll עלול לצרוך משאבים רבים מדי אם יהיו יותר מדי תוצאות.
updateMetadata(ref, metadata) מעדכן את המטא נתונים עבור אובייקט זה.
uploadBytes(ref, data, metadata) מעלה נתונים למיקום האובייקט הזה. ההעלאה אינה ניתנת לחידוש.
uploadBytesResumable(ref, data, metadata) מעלה נתונים למיקום האובייקט הזה. ניתן להשהות ולחדש את ההעלאה, וחושפת עדכוני התקדמות.
uploadString(ref, value, format, metadata) מעלה מחרוזת למיקום האובייקט הזה. ההעלאה אינה ניתנת לחידוש.
function(storageOrRef, ...)
ref(storageOrRef, path) מחזירה StorageReference עבור הנתיב הנתון בדלי ברירת המחדל.

שיעורים

מעמד תיאור
StorageError שגיאה שהוחזרה על ידי Firebase Storage SDK.

ספירות

ספירה תיאור
StorageErrorCode קודי שגיאה שניתן לצרף לאובייקטי StorageError .

ממשקים

מִמְשָׁק תיאור
FirebaseStorage מופע Firebase Storage.
מטא נתונים מלאים הסט המלא של מטא נתונים של אובייקט, כולל מאפייני קריאה בלבד.
ListOptions list() מקבלת.
תוצאות רשימה התוצאה הוחזרה על ידי list().
SetableMetadata מטא נתונים של אובייקט שניתן להגדיר בכל עת.
StorageObserver תצפיתנית זרם עבור Firebase Storage.
StorageReference מייצג הפניה לאובייקט של Google Cloud Storage. מפתחים יכולים להעלות, להוריד ולמחוק אובייקטים, כמו גם לקבל/להגדיר מטא נתונים של אובייקט.
העלה מטא נתונים מטא נתונים של אובייקט שניתן להגדיר בעת העלאה.
UploadResult התוצאה הוחזרה מהעלאה שאינה ניתנת לחידוש.
UploadTask מייצג את תהליך העלאת אובייקט. מאפשר לך לפקח ולנהל את ההעלאה.
UploadTaskSnapshot מחזיק נתונים לגבי המצב הנוכחי של משימת ההעלאה.

משתנים

מִשְׁתַנֶה תיאור
StringFormat ספירה של תבניות המחרוזות האפשריות להעלאה.

הקלד כינויים

הקלד כינוי תיאור
StringFormat ספירה של תבניות המחרוזות האפשריות להעלאה.
TaskEvent אירוע שמופעל במשימה.
TaskState מייצג את המצב הנוכחי של העלאה פועלת.

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

getStorage(app, bucketUrl)

מקבל מופע FirebaseStorage עבור אפליקציית Firebase הנתונה.

חֲתִימָה:

export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפליקציה FirebaseApp אפליקציית Firebase כדי לקבל עבורו מופע של FirebaseStorage .
bucketUrl חוּט כתובת האתר gs:// אל דלי האחסון שלך ב-Firebase. אם לא עבר, משתמש בדלי האחסון המוגדר כברירת מחדל של האפליקציה.

החזרות:

FirebaseStorage

מופע של FirebaseStorage .

פונקציה (אחסון,...)

connectStorageEmulator (אחסון, מארח, יציאה, אפשרויות)

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

חֲתִימָה:

export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אִחסוּן FirebaseStorage מופע FirebaseStorage
מנחה חוּט מארח האמולטור (לדוגמה: localhost)
נמל מספר יציאת האמולטור (לדוגמה: 5001)
אפשרויות { mockUserToken?: EmulatorMockTokenOptions | חוּט; } אפשרויות אמולטור. options.mockUserToken הוא אסימון האישור המדומה לשימוש עבור כללי אבטחה לבדיקת יחידות.

החזרות:

בָּטֵל

ref(אחסון, כתובת אתר)

מחזירה StorageReference עבור כתובת האתר הנתונה.

חֲתִימָה:

export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אִחסוּן FirebaseStorage מופע FirebaseStorage .
כתובת אתר חוּט כתובת אתר. אם ריק, מחזירה הפניה לשורש.

החזרות:

StorageReference

function (ref, ...)

deleteObject(ref)

מוחק את האובייקט במיקום זה.

חֲתִימָה:

export declare function deleteObject(ref: StorageReference): Promise<void>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference לאובייקט למחיקה.

החזרות:

הבטחה<void>

Promise שנפתרת אם המחיקה תצליח.

getBlob(ref, maxDownloadSizeBytes)

מוריד את הנתונים במיקום האובייקט. מחזירה שגיאה אם ​​האובייקט לא נמצא.

כדי להשתמש בפונקציונליות זו, עליך לרשום את מקור האפליקציה שלך ברשימת ההיתרים בדלי של Cloud Storage. ראה גם https://cloud.google.com/storage/docs/configuring-cors

ממשק API זה אינו זמין ב-Node.

חֲתִימָה:

export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference היכן יש להוריד נתונים.
maxDownloadSizeBytes מספר אם מוגדר, הגודל המרבי המותר בבתים לאחזור.

החזרות:

הבטחה<Blob>

הבטחה שנפתרת עם Blob המכיל את הבייטים של האובייקט

getBytes(ref, maxDownloadSizeBytes)

מוריד את הנתונים במיקום האובייקט. מחזירה שגיאה אם ​​האובייקט לא נמצא.

כדי להשתמש בפונקציונליות זו, עליך לרשום את מקור האפליקציה שלך ברשימת ההיתרים בדלי של Cloud Storage. ראה גם https://cloud.google.com/storage/docs/configuring-cors

חֲתִימָה:

export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference היכן יש להוריד נתונים.
maxDownloadSizeBytes מספר אם מוגדר, הגודל המרבי המותר בבתים לאחזור.

החזרות:

הבטחה<ArrayBuffer>

הבטחה המכילה את הבייטים של האובייקט

getDownloadURL(ref)

מחזירה את כתובת האתר להורדה עבור StorageReference הנתון .

חֲתִימָה:

export declare function getDownloadURL(ref: StorageReference): Promise<string>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference לקבלת כתובת האתר להורדה.

החזרות:

הבטחה<string>

Promise שנפתרת עם כתובת האתר להורדה של אובייקט זה.

getMetadata(ref)

Promise שנפתרת עם המטא נתונים עבור אובייקט זה. אם אובייקט זה אינו קיים או שלא ניתן לאחזר מטא נתונים, ההבטחה נדחית.

חֲתִימָה:

export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference שממנו ניתן לקבל מטא נתונים.

החזרות:

הבטחה< FullMetadata >

getStream(ref, maxDownloadSizeBytes)

מוריד את הנתונים במיקום האובייקט. מעלה אירוע שגיאה אם ​​האובייקט לא נמצא.

ממשק API זה זמין רק ב-Node.

חֲתִימָה:

export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference היכן יש להוריד נתונים.
maxDownloadSizeBytes מספר אם מוגדר, הגודל המרבי המותר בבתים לאחזור.

החזרות:

NodeJS.ReadableStream

זרם עם נתוני האובייקט כבייטים

רשימה (ר', אפשרויות)

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

רשימה API זמין רק עבור Firebase Rules גרסה 2.

GCS היא חנות מפתחות. Firebase Storage כופה את הסמנטיקה של מבנה התיקיות המופרד '/'. עיין ב- List API של GCS אם ברצונך ללמוד עוד.

כדי לציית לסמנטיקה של כללי Firebase, Firebase Storage אינו תומך באובייקטים שהנתיבים שלהם מסתיימים ב-"/" או מכילים שני "/" עוקבים. Firebase Storage List API יסנן את האובייקטים הלא נתמכים האלה. list() עלול להיכשל אם יש יותר מדי אובייקטים לא נתמכים בדלי.

חֲתִימָה:

export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference לקבל רשימה ממנה.
אפשרויות ListOptions ראה אפשרויות רשימה לפרטים.

החזרות:

הבטחה< ListResult >

Promise שנפתרת עם הפריטים והקידומות. prefixes מכילות הפניות לתיקיות משנה items מכילים הפניות לאובייקטים בתיקייה זו. ניתן להשתמש nextPageToken כדי לקבל את שאר התוצאות.

listAll(ref)

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

זוהי שיטת עוזר לקריאה ל-list() שוב ושוב עד שאין יותר תוצאות. גודל העימוד המוגדר כברירת מחדל הוא 1000.

חֲתִימָה:

export declare function listAll(ref: StorageReference): Promise<ListResult>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference לקבל רשימה ממנה.

החזרות:

הבטחה< ListResult >

Promise שנפתרת עם כל הפריטים והקידומות תחת אסמכתא האחסון הנוכחית. prefixes מכילות הפניות לספריות משנה items מכילים הפניות לאובייקטים בתיקייה זו. nextPageToken לעולם לא מוחזר.

updateMetadata(ref, metadata)

מעדכן את המטא נתונים עבור אובייקט זה.

חֲתִימָה:

export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference לעדכון מטא נתונים עבור.
מטא נתונים SetableMetadata המטא נתונים החדשים עבור האובייקט. רק ערכים שהוגדרו במפורש ישתנו. הגדרה מפורשת של ערך ל-null תסיר את המטא נתונים.

החזרות:

הבטחה< FullMetadata >

Promise שנפתרת עם המטא נתונים החדשים עבור אובייקט זה.

uploadBytes(ref, data, metadata)

מעלה נתונים למיקום האובייקט הזה. ההעלאה אינה ניתנת לחידוש.

חֲתִימָה:

export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference לאן יש להעלות נתונים.
נתונים כתם | Uint8Array | ArrayBuffer הנתונים להעלאה.
מטא נתונים העלה מטא נתונים מטא נתונים עבור הנתונים להעלאה.

החזרות:

הבטחה< UploadResult >

הבטחה המכילה תוצאת העלאה

uploadBytesResumable(ref, data, metadata)

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

חֲתִימָה:

export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference לאן יש להעלות נתונים.
נתונים כתם | Uint8Array | ArrayBuffer הנתונים להעלאה.
מטא נתונים העלה מטא נתונים מטא נתונים עבור הנתונים להעלאה.

החזרות:

UploadTask

משימה להעלאה

uploadString(ref, value, format, metadata)

מעלה מחרוזת למיקום האובייקט הזה. ההעלאה אינה ניתנת לחידוש.

חֲתִימָה:

export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
ref StorageReference StorageReference לאן יש להעלות מחרוזת.
ערך חוּט המחרוזת להעלות.
פוּרמָט StringFormat הפורמט של המחרוזת להעלאה.
מטא נתונים העלה מטא נתונים מטא נתונים עבור המחרוזת להעלאה.

החזרות:

הבטחה< UploadResult >

הבטחה המכילה תוצאת העלאה

function(storageOrRef, ...)

ref(storageOrRef, path)

מחזירה StorageReference עבור הנתיב הנתון בדלי ברירת המחדל.

חֲתִימָה:

export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
storageOrRef FirebaseStorage | StorageReference FirebaseStorage או StorageReference .
נָתִיב חוּט

החזרות:

StorageReference

StringFormat

ספירה של תבניות המחרוזות האפשריות להעלאה.

חֲתִימָה:

StringFormat: {
    readonly RAW: "raw";
    readonly BASE64: "base64";
    readonly BASE64URL: "base64url";
    readonly DATA_URL: "data_url";
}

StringFormat

ספירה של תבניות המחרוזות האפשריות להעלאה.

חֲתִימָה:

export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];

TaskEvent

אירוע שמופעל במשימה.

חֲתִימָה:

export declare type TaskEvent = 'state_changed';

TaskState

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

חֲתִימָה:

export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';

StorageErrorCode

קודי שגיאה שניתן לצרף לאובייקטי StorageError .

חֲתִימָה:

export declare enum StorageErrorCode

חברי ספירה

חבר ערך תיאור
APP_DELETED "app-deleted"
BUCKET_NOT_FOUND "bucket-not-found"
מבוטל "canceled"
CANNOT_SLICE_BLOB "cannot-slice-blob"
שגיאה פנימית "internal-error"
INVALID_ARGUMENT "invalid-argument"
INVALID_ARGUMENT_COUNT "invalid-argument-count"
INVALID_CHECKSUM "invalid-checksum"
INVALID_DEFAULT_BUCKET "invalid-default-bucket"
INVALID_EVENT_NAME "invalid-event-name"
INVALID_FORMAT "invalid-format"
INVALID_ROOT_OPERATION "invalid-root-operation"
INVALID_URL "invalid-url"
NO_DEFAULT_BUCKET "no-default-bucket"
NO_DOWNLOAD_URL "no-download-url"
OBJECT_NOT_FOUND "object-not-found"
PROJECT_NOT_FOUND "project-not-found"
חריגה מהמכסה "quota-exceeded"
RETRY_LIMIT_EXCEEDED "retry-limit-exceeded"
SERVER_FILE_WRONG_SIZE "server-file-wrong-size"
לא מאומת "unauthenticated"
לא מורשה "unauthorized"
UNAUTHORIZED_APP "unauthorized-app"
לא ידוע "unknown"
UNSUPPORTED_ENVIRONMENT "unsupported-environment"