storage package

فضای ذخیره سازی ابری برای Firebase

کارکرد

تابع شرح
عملکرد (برنامه، ...)
getStorage (برنامه، bucketUrl) یک نمونه FirebaseStorage برای برنامه Firebase داده شده دریافت می کند.
عملکرد (ذخیره، ...)
connectStorageEmulator (ذخیره سازی، میزبان، پورت، گزینه ها) این نمونه FirebaseStorage را برای برقراری ارتباط با شبیه ساز Cloud Storage تغییر دهید.
ref (ذخیره، آدرس اینترنتی) یک StorageReference برای URL داده شده برمی گرداند.
تابع (رجوع، ...)
deleteObject(ref) شی را در این مکان حذف می کند.
getBlob(ref، maxDownloadSizeBytes) داده ها را در محل شی دانلود می کند. اگر شیء پیدا نشد، خطا را برمی‌گرداند. برای استفاده از این قابلیت، باید مبدا برنامه خود را در سطل فضای ذخیره سازی ابری خود در لیست سفید قرار دهید. همچنین به https://cloud.google.com/storage/docs/configuring-cors مراجعه کنید این API در Node موجود نیست.
getBytes (ref، maxDownloadSizeBytes) داده ها را در محل شی دانلود می کند. اگر شیء پیدا نشد، خطا را برمی‌گرداند. برای استفاده از این قابلیت، باید مبدا برنامه خود را در سطل فضای ذخیره سازی ابری خود در لیست سفید قرار دهید. همچنین به https://cloud.google.com/storage/docs/configuring-cors مراجعه کنید
getDownloadURL(رجوع) URL دانلود را برای StorageReference داده شده برمی گرداند .
getMetadata (رجوع) یک Promise که با فراداده این شی حل می شود. اگر این شی وجود نداشته باشد یا ابرداده قابل بازیابی نباشد، قول رد می شود.
getStream (ref، maxDownloadSizeBytes) داده ها را در محل شی دانلود می کند. در صورت پیدا نشدن شی، یک رویداد خطا ایجاد می کند. این API فقط در Node موجود است.
لیست (مرجع، گزینه ها) موارد (فایل ها) و پیشوندها (پوشه ها) را در این مرجع ذخیره سازی فهرست کنید. List API فقط برای Firebase Rules نسخه 2 در دسترس است. GCS یک فروشگاه کلیدی است. Firebase Storage معنای ساختار پوشه محدود شده '/' را تحمیل می کند. اگر می خواهید بیشتر بدانید به GCS's List API مراجعه کنید. برای رعایت معنایی قوانین Firebase، Firebase Storage از اشیایی که مسیرهای آنها به "/" ختم می شود یا حاوی دو "/" متوالی است، پشتیبانی نمی کند. Firebase Storage List API این اشیاء پشتیبانی نشده را فیلتر می کند. لیست() ممکن است در صورت وجود تعداد زیادی اشیاء پشتیبانی نشده در سطل شکست بخورد.
listAll(رجوع) همه موارد (فایل ها) و پیشوندها (پوشه ها) را در این مرجع ذخیره سازی فهرست کنید. این یک روش کمکی برای فراخوانی مکرر list() است تا زمانی که نتیجه دیگری وجود نداشته باشد. اندازه صفحه پیش فرض 1000 است. توجه: در صورت تغییر اشیا در حین اجرای این عملیات، نتایج ممکن است سازگار نباشد. اخطار: listAll ممکن است به طور بالقوه منابع زیادی را در صورت وجود نتایج زیاد مصرف کنند.
به روز رسانی متادیتا (رجوع، فراداده) متادیتا را برای این شی به روز می کند.
آپلود بایت (رجوع، داده، ابرداده) داده ها را در مکان این شی آپلود می کند. آپلود قابل ازسرگیری نیست.
uploadBytesResumable (رجوع، داده، ابرداده) داده ها را در مکان این شی آپلود می کند. آپلود را می توان متوقف کرد و از سر گرفت و به روز رسانی های پیشرفت را نشان می دهد.
uploadString (رجوع، مقدار، قالب، ابرداده) یک رشته را در مکان این شی آپلود می کند. آپلود قابل ازسرگیری نیست.
تابع (storageOrRef، ...)
ref (storageOrRef، مسیر) یک StorageReference برای مسیر داده شده در سطل پیش‌فرض برمی‌گرداند.

کلاس ها

کلاس شرح
StorageError خطایی توسط Firebase Storage SDK برگردانده شد.

شمارش ها

شمارش شرح
StorageErrorCode کدهای خطا که می توانند به اشیاء StorageError متصل شوند.

رابط ها

رابط شرح
FirebaseStorage یک نمونه Firebase Storage.
فول متادیتا مجموعه کامل ابرداده های شی، از جمله ویژگی های فقط خواندنی.
ListOptions گزینه list() می پذیرد.
لیست نتیجه نتیجه توسط list().
SettableMetadata ابرداده شی که می تواند در هر زمان تنظیم شود.
StorageObserver یک ناظر جریان برای Firebase Storage.
مرجع ذخیره سازی نشان دهنده ارجاع به یک شیء Google Cloud Storage است. توسعه‌دهندگان می‌توانند اشیاء را آپلود، دانلود و حذف کنند، و همچنین ابرداده‌های شی را دریافت/تنظیم کنند.
آپلود متادیتا ابرداده شی که می تواند هنگام آپلود تنظیم شود.
آپلود نتیجه نتیجه از یک آپلود غیرقابل ادامه بازگشت.
UploadTask فرآیند آپلود یک شی را نشان می دهد. به شما امکان نظارت و مدیریت آپلود را می دهد.
UploadTaskSnapshot اطلاعات مربوط به وضعیت فعلی کار آپلود را نگهداری می کند.

متغیرها

متغیر شرح
StringFormat شمارشی از قالب‌های رشته ممکن برای آپلود.

نام مستعار را تایپ کنید

نام مستعار را تایپ کنید شرح
StringFormat شمارشی از قالب‌های رشته ممکن برای آپلود.
TaskEvent رویدادی که در یک کار ایجاد می شود.
TaskState وضعیت فعلی یک آپلود در حال اجرا را نشان می دهد.

عملکرد (برنامه، ...)

getStorage (برنامه، bucketUrl)

یک نمونه FirebaseStorage برای برنامه Firebase داده شده دریافت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه Firebase App برنامه Firebase برای دریافت نمونه FirebaseStorage .
bucketUrl رشته آدرس gs:// به سطل ذخیره سازی Firebase شما. اگر تصویب نشد، از Storage Bucket پیش‌فرض برنامه استفاده می‌کند.

برمی گرداند:

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 برای URL داده شده برمی گرداند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
ذخیره سازی FirebaseStorage نمونه FirebaseStorage .
آدرس اینترنتی رشته URL. اگر خالی باشد، مرجع ریشه را برمی‌گرداند.

برمی گرداند:

مرجع ذخیره سازی

تابع (رجوع، ...)

deleteObject(ref)

شی را در این مکان حذف می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference برای شیئی که باید حذف شود.

برمی گرداند:

قول<باطل>

Promise که در صورت موفقیت آمیز بودن حذف برطرف می شود.

getBlob(ref، maxDownloadSizeBytes)

داده ها را در محل شی دانلود می کند. اگر شیء پیدا نشد، خطا را برمی‌گرداند.

برای استفاده از این قابلیت، باید مبدا برنامه خود را در سطل فضای ذخیره سازی ابری خود در لیست سفید قرار دهید. همچنین به https://cloud.google.com/storage/docs/configuring-cors مراجعه کنید

این API در Node موجود نیست.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference که در آن داده ها باید دانلود شوند.
maxDownloadSizeBytes عدد در صورت تنظیم، حداکثر اندازه مجاز در بایت برای بازیابی.

برمی گرداند:

قول<Blob>

یک Promise که با یک Blob حاوی بایت های شی حل می شود

getBytes (ref، maxDownloadSizeBytes)

داده ها را در محل شی دانلود می کند. اگر شی پیدا نشد، خطا را برمی‌گرداند.

برای استفاده از این قابلیت، باید مبدا برنامه خود را در سطل فضای ذخیره سازی ابری خود در لیست سفید قرار دهید. همچنین به https://cloud.google.com/storage/docs/configuring-cors مراجعه کنید

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference که در آن داده ها باید دانلود شوند.
maxDownloadSizeBytes عدد در صورت تنظیم، حداکثر اندازه مجاز در بایت برای بازیابی.

برمی گرداند:

Promise<ArrayBuffer>

یک وعده حاوی بایت های شی

getDownloadURL(رجوع)

URL دانلود را برای StorageReference داده شده برمی گرداند .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference برای دریافت URL دانلود برای.

برمی گرداند:

قول<رشته>

یک Promise که با URL دانلود برای این شی حل می شود.

getMetadata (رجوع)

یک Promise که با فراداده این شی حل می شود. اگر این شی وجود نداشته باشد یا ابرداده قابل بازیابی نباشد، قول رد می شود.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference برای دریافت فراداده از.

برمی گرداند:

Promise< FullMetadata >

getStream (ref، maxDownloadSizeBytes)

داده ها را در محل شی دانلود می کند. در صورت پیدا نشدن شی، یک رویداد خطا ایجاد می کند.

این API فقط در Node موجود است.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference که در آن داده ها باید دانلود شوند.
maxDownloadSizeBytes عدد در صورت تنظیم، حداکثر اندازه مجاز در بایت برای بازیابی.

برمی گرداند:

NodeJS.ReadableStream

جریانی با داده های شی به صورت بایت

لیست (مرجع، گزینه ها)

موارد (فایل ها) و پیشوندها (پوشه ها) را در این مرجع ذخیره سازی فهرست کنید.

List API فقط برای Firebase Rules نسخه 2 در دسترس است.

GCS یک فروشگاه کلیدی است. Firebase Storage معنای ساختار پوشه محدود شده '/' را تحمیل می کند. اگر می خواهید بیشتر بدانید به GCS's List API مراجعه کنید.

برای رعایت معنایی قوانین Firebase، Firebase Storage از اشیایی که مسیرهای آنها به "/" ختم می شود یا حاوی دو "/" متوالی است، پشتیبانی نمی کند. Firebase Storage List API این اشیاء پشتیبانی نشده را فیلتر می کند. لیست() ممکن است در صورت وجود تعداد زیادی اشیاء پشتیبانی نشده در سطل شکست بخورد.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference برای دریافت لیست از.
گزینه ها ListOptions برای جزئیات بیشتر به ListOptions مراجعه کنید.

برمی گرداند:

Promise< List Result >

Promise که با آیتم ها و پیشوندها حل می شود. prefixes شامل ارجاع به زیر پوشه ها و items حاوی ارجاعاتی به اشیاء در این پوشه است. nextPageToken می توان برای دریافت بقیه نتایج استفاده کرد.

listAll(رجوع)

همه موارد (فایل ها) و پیشوندها (پوشه ها) را در این مرجع ذخیره سازی فهرست کنید.

این یک روش کمکی برای فراخوانی مکرر list() است تا زمانی که نتیجه دیگری وجود نداشته باشد. اندازه صفحه پیش فرض 1000 است.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference برای دریافت لیست از.

برمی گرداند:

Promise< List Result >

یک Promise که با همه موارد و پیشوندها در مرجع ذخیره سازی فعلی حل می شود. prefixes شامل ارجاع به زیر شاخه ها و items حاوی ارجاعاتی به اشیاء در این پوشه است. nextPageToken هرگز برگردانده نمی شود.

به روز رسانی متادیتا (رجوع، فراداده)

متادیتا را برای این شی به روز می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference برای به روز رسانی متادیتا برای.
فراداده SettableMetadata ابرداده جدید برای شی. فقط مقادیری که به صراحت تنظیم شده اند تغییر خواهند کرد. تنظیم صریح یک مقدار به null، ابرداده را حذف می کند.

برمی گرداند:

Promise< FullMetadata >

یک Promise که با ابرداده جدید برای این شی حل می شود.

آپلود بایت (رجوع، داده، ابرداده)

داده ها را در مکان این شی آپلود می کند. آپلود قابل ازسرگیری نیست.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference جایی که داده ها باید آپلود شوند.
داده ها لکه | Uint8Array | ArrayBuffer داده هایی برای آپلود
فراداده آپلود متادیتا فراداده برای داده ها برای آپلود.

برمی گرداند:

قول < آپلود نتیجه >

یک وعده حاوی یک نتیجه آپلود

uploadBytesResumable (رجوع، داده، ابرداده)

داده ها را در مکان این شی آپلود می کند. آپلود را می توان متوقف کرد و از سر گرفت و به روز رسانی های پیشرفت را نشان می دهد.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference جایی که داده ها باید آپلود شوند.
داده ها لکه | Uint8Array | ArrayBuffer داده هایی برای آپلود
فراداده آپلود متادیتا فراداده برای داده ها برای آپلود.

برمی گرداند:

UploadTask

یک UploadTask

uploadString (رجوع، مقدار، قالب، ابرداده)

یک رشته را در مکان این شی آپلود می کند. آپلود قابل ازسرگیری نیست.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
مرجع مرجع ذخیره سازی StorageReference جایی که رشته باید آپلود شود.
ارزش رشته رشته برای آپلود.
قالب StringFormat قالب رشته برای آپلود.
فراداده آپلود متادیتا ابرداده برای رشته برای آپلود.

برمی گرداند:

قول < آپلود نتیجه >

یک وعده حاوی یک نتیجه آپلود

تابع (storageOrRef، ...)

ref (storageOrRef، مسیر)

یک StorageReference را برای مسیر داده شده در سطل پیش فرض برمی گرداند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
storageOrRef FirebaseStorage | مرجع ذخیره سازی FirebaseStorage یا 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 "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"