storage package

फायरबेस के लिए क्लाउड स्टोरेज

कार्य

कक्षाओं

गणना

इंटरफेस

चर

उपनाम टाइप करें

फ़ंक्शन (ऐप, ...)

getStorage(ऐप, BucketUrl)

दिए गए फ़ायरबेस ऐप के लिए फ़ायरबेसस्टोरेज उदाहरण प्राप्त होता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

फायरबेसस्टोरेज

एक फायरबेसस्टोरेज उदाहरण।

फ़ंक्शन (भंडारण, ...)

कनेक्टस्टोरेजएमुलेटर (भंडारण, होस्ट, पोर्ट, विकल्प)

क्लाउड स्टोरेज एमुलेटर के साथ संचार करने के लिए इस फायरबेसस्टोरेज इंस्टेंस को संशोधित करें।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

खालीपन

रेफरी(भंडारण, यूआरएल)

दिए गए यूआरएल के लिए एक स्टोरेज रेफरेंस लौटाता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

भंडारण संदर्भ

फ़ंक्शन (रेफरी, ...)

डिलीटऑब्जेक्ट(रेफरी)

इस स्थान पर ऑब्जेक्ट को हटा देता है.

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<शून्य>

एक Promise जो विलोपन सफल होने पर हल हो जाता है।

getBlob(रेफ, maxDownloadSizeBytes)

ऑब्जेक्ट के स्थान पर डेटा डाउनलोड करता है। यदि ऑब्जेक्ट नहीं मिलता है तो एक त्रुटि लौटाता है।

इस कार्यक्षमता का उपयोग करने के लिए, आपको अपने ऐप के मूल को अपने क्लाउड स्टोरेज बकेट में श्वेतसूची में डालना होगा। https://cloud.google.com/storage/docs/configuring-cors भी देखें

यह एपीआई नोड में उपलब्ध नहीं है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<ब्लॉब>

एक वादा जो ऑब्जेक्ट के बाइट्स वाले ब्लॉब के साथ हल होता है

getBytes(रेफ, maxDownloadSizeBytes)

ऑब्जेक्ट के स्थान पर डेटा डाउनलोड करता है। यदि ऑब्जेक्ट नहीं मिलता है तो एक त्रुटि लौटाता है।

इस कार्यक्षमता का उपयोग करने के लिए, आपको अपने ऐप के मूल को अपने क्लाउड स्टोरेज बकेट में श्वेतसूची में डालना होगा। https://cloud.google.com/storage/docs/configuring-cors भी देखें

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<ArrayBuffer>

एक वादा जिसमें ऑब्जेक्ट के बाइट्स शामिल हैं

GetDownloadURL(रेफ)

दिए गए स्टोरेज रेफरेंस के लिए डाउनलोड यूआरएल लौटाता है .

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<स्ट्रिंग>

एक Promise जो इस ऑब्जेक्ट के लिए डाउनलोड यूआरएल के साथ हल होता है।

getMetadata(रेफ)

एक Promise जो इस ऑब्जेक्ट के मेटाडेटा के साथ हल होता है। यदि यह ऑब्जेक्ट मौजूद नहीं है या मेटाडेटा पुनर्प्राप्त नहीं किया जा सकता है, तो वादा अस्वीकार कर दिया गया है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< पूर्णमेटाडेटा >

getStream(रेफ, maxDownloadSizeBytes)

ऑब्जेक्ट के स्थान पर डेटा डाउनलोड करता है। यदि ऑब्जेक्ट नहीं मिलता है तो एक त्रुटि घटना उत्पन्न होती है।

यह एपीआई केवल नोड में उपलब्ध है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

NodeJS.ReadableStream

ऑब्जेक्ट के डेटा को बाइट्स के रूप में रखने वाली एक स्ट्रीम

सूची(संदर्भ, विकल्प)

इस भंडारण संदर्भ के अंतर्गत आइटम (फ़ाइलें) और उपसर्ग (फ़ोल्डर) सूचीबद्ध करें।

सूची एपीआई केवल फायरबेस नियम संस्करण 2 के लिए उपलब्ध है।

जीसीएस एक की-ब्लॉब स्टोर है। फायरबेस स्टोरेज '/' सीमांकित फ़ोल्डर संरचना का अर्थ लगाता है। यदि आप अधिक जानना चाहते हैं तो जीसीएस की सूची एपीआई देखें।

फायरबेस नियमों के शब्दार्थ का पालन करने के लिए, फायरबेस स्टोरेज उन वस्तुओं का समर्थन नहीं करता है जिनके पथ "/" पर समाप्त होते हैं या जिनमें लगातार दो "/" होते हैं। फायरबेस स्टोरेज लिस्ट एपीआई इन असमर्थित ऑब्जेक्ट्स को फ़िल्टर करेगा। यदि बकेट में बहुत अधिक असमर्थित ऑब्जेक्ट हैं तो सूची() विफल हो सकती है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< सूचीपरिणाम >

एक Promise जो वस्तुओं और उपसर्गों के साथ हल होता है। prefixes में उप-फ़ोल्डरों के संदर्भ होते हैं और items में इस फ़ोल्डर में ऑब्जेक्ट के संदर्भ होते हैं। बाकी परिणाम प्राप्त करने के लिए nextPageToken उपयोग किया जा सकता है।

सूचीसभी(रेफरी)

इस भंडारण संदर्भ के अंतर्गत सभी आइटम (फ़ाइलें) और उपसर्ग (फ़ोल्डर) सूचीबद्ध करें।

यह सूची() को बार-बार कॉल करने के लिए एक सहायक विधि है जब तक कि कोई और परिणाम न हो। डिफ़ॉल्ट पेजिनेशन आकार 1000 है.

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< सूचीपरिणाम >

एक Promise जो वर्तमान भंडारण संदर्भ के तहत सभी वस्तुओं और उपसर्गों के साथ हल होता है। prefixes में उप-निर्देशिकाओं के संदर्भ होते हैं और items में इस फ़ोल्डर में ऑब्जेक्ट के संदर्भ होते हैं। nextPageToken कभी वापस नहीं किया जाता।

अपडेटमेटाडेटा(रेफ, मेटाडेटा)

इस ऑब्जेक्ट के लिए मेटाडेटा अपडेट करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< पूर्णमेटाडेटा >

एक Promise जो इस ऑब्जेक्ट के लिए नए मेटाडेटा के साथ हल होता है।

uploadBytes(रेफरी, डेटा, मेटाडेटा)

इस ऑब्जेक्ट के स्थान पर डेटा अपलोड करता है। अपलोड दोबारा शुरू नहीं किया जा सकता.

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< अपलोडपरिणाम >

एक वादा जिसमें अपलोडरिजल्ट शामिल है

uploadBytesResumable(रेफरी, डेटा, मेटाडेटा)

इस ऑब्जेक्ट के स्थान पर डेटा अपलोड करता है। अपलोड को रोका और फिर से शुरू किया जा सकता है, और प्रगति अद्यतन प्रदर्शित करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

अपलोड कार्य

एक अपलोड कार्य

uploadString(रेफ, मान, प्रारूप, मेटाडेटा)

इस ऑब्जेक्ट के स्थान पर एक स्ट्रिंग अपलोड करता है। अपलोड दोबारा शुरू नहीं किया जा सकता.

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< अपलोडपरिणाम >

एक वादा जिसमें अपलोडरिजल्ट शामिल है

फ़ंक्शन (स्टोरेजऑररेफ, ...)

रेफरी(स्टोरेजऑररेफ, पथ)

डिफ़ॉल्ट बकेट में दिए गए पथ के लिए एक स्टोरेज रेफरेंस लौटाता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

भंडारण संदर्भ

स्ट्रिंगफॉर्मेट

अपलोड के लिए संभावित स्ट्रिंग प्रारूपों की गणना।

हस्ताक्षर:

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

स्ट्रिंगफॉर्मेट

अपलोड के लिए संभावित स्ट्रिंग प्रारूपों की गणना।

हस्ताक्षर:

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

टास्कइवेंट

एक घटना जो किसी कार्य पर ट्रिगर होती है।

हस्ताक्षर:

export declare type TaskEvent = 'state_changed';

कार्यस्थिति

चल रहे अपलोड की वर्तमान स्थिति का प्रतिनिधित्व करता है।

हस्ताक्षर:

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

भंडारणत्रुटिकोड

त्रुटि कोड जिन्हें StorageError ऑब्जेक्ट से जोड़ा जा सकता है।

हस्ताक्षर:

export declare enum StorageErrorCode 

गणना सदस्य