storage package

Firebase용 Cloud Storage

함수

클래스

열거

인터페이스

변수

유형 별칭

함수(앱, ...)

getStorage(app, bucketUrl)

지정된 Firebase 앱의 FirebaseStorage 인스턴스를 가져옵니다.

서명:

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

매개변수

반환:

FirebaseStorage

FirebaseStorage 인스턴스.

function(storage, ...)

connectStorageEmulator(스토리지, 호스트, 포트, 옵션)

Cloud Storage 에뮬레이터와 통신하도록 이 FirebaseStorage 인스턴스를 수정합니다.

서명:

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

매개변수

반환:

void

ref(storage, url)

지정된 URL의 StorageReference를 반환합니다.

서명:

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

매개변수

반환:

저장소 참조

함수(ref, ...)

deleteObject(ref)

이 위치에서 객체를 삭제합니다.

서명:

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

매개변수

반환:

프로미스<void>

삭제에 성공하면 결정되는 Promise입니다.

getBlob(ref, maxDownloadSizeBytes)

객체의 위치에 데이터를 다운로드합니다. 객체를 찾을 수 없는 경우 오류를 반환합니다.

이 기능을 사용하려면 Cloud Storage 버킷에서 앱 출처를 허용 목록에 추가해야 합니다. https://cloud.google.com/storage/docs/organize-cors도 참고하세요.

이 API는 노드에서 사용할 수 없습니다.

서명:

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

매개변수

반환:

프로미스<Blob>

객체의 바이트가 포함된 Blob으로 확인되는 프로미스

getBytes(ref, maxDownloadSizeBytes)

객체의 위치에 데이터를 다운로드합니다. 객체를 찾을 수 없는 경우 오류를 반환합니다.

이 기능을 사용하려면 Cloud Storage 버킷에서 앱 출처를 허용 목록에 추가해야 합니다. https://cloud.google.com/storage/docs/organize-cors도 참고하세요.

서명:

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

매개변수

반환:

<ArrayBuffer> 프로미스

객체의 바이트를 포함하는 프로미스

getDownloadURL(참조)

지정된 StorageReference의 다운로드 URL을 반환합니다.

서명:

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

매개변수

반환:

프로미스<string>

이 객체의 다운로드 URL로 확인되는 Promise입니다.

getMetadata(ref)

이 객체의 메타데이터로 확인되는 Promise입니다. 이 객체가 없거나 메타데이터를 검색할 수 없는 경우 프로미스가 거부됩니다.

서명:

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

매개변수

반환:

프로미스<FullMetadata>

getStream(ref, maxDownloadSizeBytes)

객체의 위치에 데이터를 다운로드합니다. 객체를 찾을 수 없으면 오류 이벤트가 발생합니다.

이 API는 노드에서만 사용할 수 있습니다.

서명:

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

매개변수

반환:

ReadableStream

객체의 데이터를 바이트인 스트림

list(참조, 옵션)

이 스토리지 참조 아래의 항목 (파일) 및 접두사 (폴더)를 나열합니다.

List API는 Firebase 규칙 버전 2에서만 사용할 수 있습니다.

GCS는 키-blob 저장소입니다. Firebase 저장소는 '/'의 시맨틱을 적용합니다. 찾을 수 있습니다. 자세한 내용은 GCS의 List API를 참고하세요.

Firebase 규칙의 시맨틱스를 준수하기 위해 Firebase 저장소는 경로가 '/'로 끝나는 객체를 지원하지 않습니다. 또는 두 개의 '/'를 연속으로 포함해야 합니다. Firebase Storage List API가 지원되지 않는 객체를 필터링합니다. 버킷에 지원되지 않는 객체가 너무 많으면 list()가 실패할 수 있습니다.

서명:

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

매개변수

반환:

프로미스 <ListResult>

항목과 접두사로 확인되는 Promise입니다. prefixes에는 하위 폴더에 대한 참조가 포함되고 items에는 이 폴더의 객체에 대한 참조가 포함됩니다. nextPageToken를 사용하여 나머지 결과를 가져올 수 있습니다.

listAll(참조)

이 스토리지 참조 아래의 모든 항목 (파일) 및 접두사 (폴더)를 나열합니다.

이는 더 이상 결과가 없을 때까지 list()를 반복적으로 호출하는 도우미 메서드입니다. 기본 페이지로 나누기 크기는 1,000입니다.

서명:

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

매개변수

반환:

프로미스 <ListResult>

현재 저장소 참조 아래의 모든 항목과 접두사로 확인되는 Promise입니다. prefixes에는 하위 디렉터리 참조가 포함되고 items에는 이 폴더의 객체에 대한 참조가 포함됩니다. nextPageToken는 반환되지 않습니다.

updateMetadata(ref, metadata)

이 객체의 메타데이터를 업데이트합니다.

서명:

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

매개변수

반환:

프로미스<FullMetadata>

이 객체의 새 메타데이터로 확인되는 Promise입니다.

uploadBytes(참조, 데이터, 메타데이터)

이 객체의 위치에 데이터를 업로드합니다. 업로드를 재개할 수 없습니다.

서명:

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

매개변수

반환:

<UploadResult> 프라미스

UploadResult를 포함하는 프라미스

uploadBytesResumable(참조, 데이터, 메타데이터)

이 객체의 위치에 데이터를 업로드합니다. 업로드는 일시중지 및 재개할 수 있으며 진행 상황 업데이트를 노출합니다.

서명:

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

매개변수

반환:

UploadTask

UploadTask

uploadString(참조, 값, 형식, 메타데이터)

이 객체의 위치에 문자열을 업로드합니다. 업로드를 재개할 수 없습니다.

서명:

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

매개변수

반환:

<UploadResult> 프라미스

UploadResult를 포함하는 프라미스

function(storageOrRef, ...)

ref(storageOrRef, path)

기본 버킷의 지정된 경로에 대한 StorageReference를 반환합니다.

서명:

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

TaskState

실행 중인 업로드의 현재 상태를 나타냅니다.

서명:

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

StorageErrorCode

StorageError 객체에 연결할 수 있는 오류 코드입니다.

서명:

export declare enum StorageErrorCode 

열거형 구성원