Firebase용 Cloud Storage
함수
| 함수 | 설명 |
|---|---|
| function(앱, ...) | |
| getStorage(app, bucketUrl) | 지정된 Firebase 앱의 FirebaseStorage 인스턴스를 가져옵니다. |
| function(storage, ...) | |
| connectStorageEmulator(스토리지, 호스트, 포트, 옵션) | Cloud Storage 에뮬레이터와 통신하도록 이 FirebaseStorage 인스턴스를 수정합니다. |
| ref(storage, url) | 지정된 URL의 StorageReference를 반환합니다. |
| 함수(ref, ...) | |
| deleteObject(ref) | 이 위치에서 객체를 삭제합니다. |
| getBlob(ref, maxDownloadSizeBytes) | 객체의 위치에 데이터를 다운로드합니다. 객체를 찾을 수 없는 경우 오류가 반환됩니다.이 기능을 사용하려면 Cloud Storage 버킷에서 앱의 출처를 허용 목록에 추가해야 합니다. https://cloud.google.com/storage/docs/organize-cors도 참고하세요.이 API는 Node에서 사용할 수 없습니다. |
| getBytes(ref, maxDownloadSizeBytes) | 객체의 위치에 데이터를 다운로드합니다. 객체를 찾을 수 없는 경우 오류가 반환됩니다.이 기능을 사용하려면 Cloud Storage 버킷에서 앱의 출처를 허용 목록에 추가해야 합니다. https://cloud.google.com/storage/docs/organize-cors도 참고하세요. |
| getDownloadURL(ref) | 지정된 StorageReference의 다운로드 URL을 반환합니다. |
| getMetadata(ref) | 이 객체의 메타데이터로 확인되는 Promise입니다. 이 객체가 없거나 메타데이터를 검색할 수 없는 경우 프로미스가 거부됩니다. |
| getStream(ref, maxDownloadSizeBytes) | 객체의 위치에 데이터를 다운로드합니다. 객체를 찾을 수 없으면 오류 이벤트가 발생합니다.이 API는 Node에서만 사용할 수 있습니다. |
| list(ref, options) | 이 스토리지 참조 아래의 항목 (파일) 및 프리픽스 (폴더)를 나열합니다.List API는 Firebase 규칙 버전 2에서만 사용할 수 있습니다.GCS는 키-blob 저장소입니다. Firebase 저장소는 '/'의 시맨틱을 적용합니다. 찾을 수 있습니다. 자세한 내용은 GCS의 List API를 참고하세요.Firebase 규칙의 시맨틱을 준수하기 위해 Firebase 저장소는 경로가 '/'로 끝나는 객체를 지원하지 않습니다. 또는 두 개의 '/'를 연속으로 포함해야 합니다. Firebase Storage List API가 지원되지 않는 객체를 필터링합니다. 버킷에 지원되지 않는 객체가 너무 많으면 list()가 실패할 수 있습니다. |
| listAll(ref) | 이 저장소 참조 아래에 모든 항목 (파일) 및 접두사 (폴더)를 나열합니다.이는 더 이상 결과가 없을 때까지 list()를 반복적으로 호출하는 도우미 메서드입니다. 기본 페이지로 나누기 크기는 1,000입니다.참고: 이 작업이 실행되는 동안 객체를 변경하면 결과가 일관되지 않을 수 있습니다.경고: 결과가 너무 많으면 listAll에서 너무 많은 리소스를 사용할 수 있습니다. |
| updateMetadata(ref, metadata) | 이 객체의 메타데이터를 업데이트합니다. |
| uploadBytes(ref, data, metadata) | 이 객체의 위치에 데이터를 업로드합니다. 업로드를 재개할 수 없습니다. |
| uploadBytesResumable(참조, 데이터, 메타데이터) | 이 객체의 위치에 데이터를 업로드합니다. 업로드는 일시중지 및 재개할 수 있으며 진행률 업데이트를 노출합니다. |
| uploadString(ref, 값, 형식, metadata) | 이 객체의 위치에 문자열을 업로드합니다. 업로드를 재개할 수 없습니다. |
| function(storageOrRef, ...) | |
| ref(storageOrRef, path) | 기본 버킷의 지정된 경로에 대한 StorageReference를 반환합니다. |
클래스
| 클래스 | 설명 |
|---|---|
| 저장소 오류 | Firebase Storage SDK에서 반환된 오류입니다. |
열거
| 열거 | 설명 |
|---|---|
| 저장소 오류 코드 | StorageError 객체에 연결할 수 있는 오류 코드입니다. |
인터페이스
| 인터페이스 | 설명 |
|---|---|
| FirebaseStorage | Firebase Storage 인스턴스 |
| FullMetadata를 선택해야 합니다. | 읽기 전용 속성을 포함한 전체 객체 메타데이터 집합입니다. |
| ListOptions | list()가 허용하는 옵션입니다. |
| ListResult | list()에서 반환된 결과입니다. |
| SettableMetadata를 참조하세요. | 언제든지 설정할 수 있는 객체 메타데이터입니다. |
| StorageObserver | Firebase 저장소의 스트림 관찰자입니다. |
| 저장소 참조 | Google Cloud Storage 객체에 대한 참조를 나타냅니다. 개발자는 객체를 업로드, 다운로드, 삭제할 뿐만 아니라 객체 메타데이터를 가져오거나 설정할 수 있습니다. |
| UploadMetadata | 업로드 시 설정할 수 있는 객체 메타데이터입니다. |
| UploadResult | 재개할 수 없는 업로드에서 반환된 결과입니다. |
| UploadTask | 객체를 업로드하는 프로세스를 나타냅니다. 업로드를 모니터링하고 관리할 수 있습니다. |
| UploadTaskSnapshot | 업로드 작업의 현재 상태에 관한 데이터를 보유합니다. |
변수
| 변수 | 설명 |
|---|---|
| 문자열 형식 | 업로드할 수 있는 문자열 형식의 열거형입니다. |
유형 별칭
| 별칭 입력 | 설명 |
|---|---|
| 문자열 형식 | 업로드할 수 있는 문자열 형식의 열거형입니다. |
| TaskEvent | 작업에서 트리거되는 이벤트입니다. |
| TaskState | 실행 중인 업로드의 현재 상태를 나타냅니다. |
함수(앱, ...)
getStorage(app, bucketUrl)
지정된 Firebase 앱의 FirebaseStorage 인스턴스를 가져옵니다.
서명:
export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 앱 | Firebase 앱 | FirebaseStorage 인스턴스를 가져올 Firebase 앱 |
| 버킷 URL | 문자열 | Firebase 스토리지 버킷의 gs:// URL입니다. 전달하지 않으면 앱의 기본 저장소 버킷을 사용합니다. |
반환:
FirebaseStorage 인스턴스
function(storage, ...)
connectStorageEmulator(스토리지, 호스트, 포트, 옵션)
Cloud Storage 에뮬레이터와 통신하도록 이 FirebaseStorage 인스턴스를 수정합니다.
서명:
export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| storage | FirebaseStorage | FirebaseStorage 인스턴스 |
| 호스트 | 문자열 | 에뮬레이터 호스트 (예: localhost) |
| 포트 | 숫자 | 에뮬레이터 포트 (예: 5001) |
| 옵션 | { fakeUserToken?: EmulatorMockTokenOptions | string; } | 에뮬레이터 옵션 options.mockUserToken는 보안 규칙 단위 테스트에 사용하는 모의 인증 토큰입니다. |
반환:
void
ref(storage, url)
지정된 URL의 StorageReference를 반환합니다.
서명:
export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| storage | FirebaseStorage | FirebaseStorage 인스턴스를 만들 수 있습니다. |
| url | 문자열 | URL입니다. 비어 있으면 루트 참조를 반환합니다. |
반환:
함수(ref, ...)
deleteObject(ref)
이 위치에서 객체를 삭제합니다.
서명:
export declare function deleteObject(ref: StorageReference): Promise<void>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | StorageReference: 삭제할 객체 |
반환:
Promise<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>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | 데이터를 다운로드해야 하는 StorageReference입니다. |
| maxDownloadSizeBytes | 숫자 | 설정할 경우 가져올 최대 허용 크기(바이트)입니다. |
반환:
프로미스<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>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | 데이터를 다운로드해야 하는 StorageReference입니다. |
| maxDownloadSizeBytes | 숫자 | 설정할 경우 가져올 최대 허용 크기(바이트)입니다. |
반환:
<ArrayBuffer> 프로미스
객체의 바이트를 포함하는 프로미스
getDownloadURL(참조)
지정된 StorageReference의 다운로드 URL을 반환합니다.
서명:
export declare function getDownloadURL(ref: StorageReference): Promise<string>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | StorageReference를 만듭니다. |
반환:
프로미스<string>
이 객체의 다운로드 URL로 확인되는 Promise입니다.
getMetadata(ref)
이 객체의 메타데이터로 확인되는 Promise입니다. 이 객체가 없거나 메타데이터를 검색할 수 없는 경우 프로미스가 거부됩니다.
서명:
export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | StorageReference를 가져옵니다. |
반환:
프로미스<FullMetadata>
getStream(ref, maxDownloadSizeBytes)
객체의 위치에 데이터를 다운로드합니다. 객체를 찾을 수 없으면 오류 이벤트가 발생합니다.
이 API는 노드에서만 사용할 수 있습니다.
서명:
export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | 데이터를 다운로드해야 하는 StorageReference입니다. |
| maxDownloadSizeBytes | 숫자 | 설정할 경우 가져올 최대 허용 크기(바이트)입니다. |
반환:
NodeJS.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>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | StorageReference를 만듭니다. |
| 옵션 | ListOptions | 자세한 내용은 ListOptions를 참조하세요. |
반환:
프로미스<ListResult>
항목과 접두사로 확인되는 Promise입니다. prefixes에는 하위 폴더에 대한 참조가 포함되고 items에는 이 폴더의 객체에 대한 참조가 포함됩니다. nextPageToken를 사용하여 나머지 결과를 가져올 수 있습니다.
listAll(참조)
이 스토리지 참조 아래의 모든 항목 (파일) 및 접두사 (폴더)를 나열합니다.
이는 더 이상 결과가 없을 때까지 list()를 반복적으로 호출하는 도우미 메서드입니다. 기본 페이지로 나누기 크기는 1,000입니다.
서명:
export declare function listAll(ref: StorageReference): Promise<ListResult>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | StorageReference를 만듭니다. |
반환:
프로미스<ListResult>
현재 저장소 참조 아래의 모든 항목과 접두사로 확인되는 Promise입니다. prefixes에는 하위 디렉터리 참조가 포함되고 items에는 이 폴더의 객체에 대한 참조가 포함됩니다. nextPageToken는 반환되지 않습니다.
updateMetadata(ref, metadata)
이 객체의 메타데이터를 업데이트합니다.
서명:
export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | StorageReference를 만듭니다. |
| metadata | SettableMetadata를 참조하세요. | 객체의 새 메타데이터입니다. 명시적으로 설정된 값만 변경됩니다. 명시적으로 값을 null로 설정하면 메타데이터가 삭제됩니다. |
반환:
프로미스<FullMetadata>
이 객체의 새 메타데이터로 확인되는 Promise입니다.
uploadBytes(참조, 데이터, 메타데이터)
이 객체의 위치에 데이터를 업로드합니다. 업로드를 재개할 수 없습니다.
서명:
export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | StorageReference를 만듭니다. |
| 데이터 | 블롭 | Uint8Array | 배열 버퍼 | 업로드할 데이터입니다. |
| metadata | UploadMetadata | 업로드할 데이터의 메타데이터입니다. |
반환:
<UploadResult> 프라미스
UploadResult를 포함하는 프라미스
uploadBytesResumable(참조, 데이터, 메타데이터)
이 객체의 위치에 데이터를 업로드합니다. 업로드는 일시중지 및 재개할 수 있으며 진행 상황 업데이트를 노출합니다.
서명:
export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | StorageReference를 만듭니다. |
| 데이터 | 블롭 | Uint8Array | 배열 버퍼 | 업로드할 데이터입니다. |
| metadata | UploadMetadata | 업로드할 데이터의 메타데이터입니다. |
반환:
UploadTask
uploadString(참조, 값, 형식, 메타데이터)
이 객체의 위치에 문자열을 업로드합니다. 업로드를 재개할 수 없습니다.
서명:
export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| ref | 저장소 참조 | StorageReference를 만듭니다. |
| 값 | 문자열 | 업로드할 문자열입니다. |
| 형식 | 문자열 형식 | 업로드할 문자열의 형식입니다. |
| metadata | UploadMetadata | 업로드할 문자열의 메타데이터입니다. |
반환:
<UploadResult> 프라미스
UploadResult를 포함하는 프라미스
function(storageOrRef, ...)
ref(storageOrRef, path)
기본 버킷의 지정된 경로에 대한 StorageReference를 반환합니다.
서명:
export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| storageOrRef | FirebaseStorage | StorageReference | FirebaseStorage 또는 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
열거형 구성원
| 구성원 | 값 | 설명 |
|---|---|---|
| APP_삭제됨 | "app-deleted" |
|
| BUCKET_NOT_FOUND | "bucket-not-found" |
|
| 취소됨 | "canceled" |
|
| CANNOT_SLICE_BLOB | "cannot-slice-blob" |
|
| INTERNAL_ERROR | "internal-error" |
|
| INVALID_ARGUMENT | "invalid-argument" |
|
| INVALID_ARGUMENT_COUNT개 | "invalid-argument-count" |
|
| 잘못된_체크SUM | "invalid-checksum" |
|
| INVALID_DEFAULT_BUCKET | "invalid-default-bucket" |
|
| 잘못된 이벤트 이름 | "invalid-event-name" |
|
| INVALID_FORMAT | "invalid-format" |
|
| 잘못된_ROOT_OPERATION | "invalid-root-operation" |
|
| 잘못된_URL | "invalid-url" |
|
| 기본값: 버킷 없음 | "no-default-bucket" |
|
| 다운로드 URL 없음 | "no-download-url" |
|
| 객체를 찾을 수 없음 | "object-not-found" |
|
| 프로젝트를 찾을 수 없음 | "project-not-found" |
|
| QUOTA_EXCEEDED개 | "quota-exceeded" |
|
| RETRY_LIMIT_EXCEEDED(재사용 한도 초과) | "retry-limit-exceeded" |
|
| SERVER_FILE_WRONG_SIZE | "server-file-wrong-size" |
|
| UNAUTHENTICATED | "unauthenticated" |
|
| UNAUTHORIZED | "unauthorized" |
|
| 승인되지 않은 앱 | "unauthorized-app" |
|
| 알 수 없음 | "unknown" |
|
| 지원되지 않는 환경 | "unsupported-environment" |