Firebase용 Cloud Storage
기능
기능 | 설명 |
---|---|
기능(앱, ...) | |
getStorage(앱, bucketUrl) | 특정 Firebase 앱에 대한 FirebaseStorage 인스턴스를 가져옵니다. |
기능(저장, ...) | |
connectStorageEmulator(스토리지, 호스트, 포트, 옵션) | Cloud Storage 에뮬레이터와 통신하도록 이 FirebaseStorage 인스턴스를 수정하세요. |
참조(저장소, URL) | 지정된 URL에 대한 StorageReference를 반환합니다. |
함수(참조, ...) | |
삭제객체(ref) | 이 위치의 개체를 삭제합니다. |
getBlob(ref, maxDownloadSizeBytes) | 개체 위치에 데이터를 다운로드합니다. 개체를 찾을 수 없으면 오류를 반환합니다. 이 기능을 사용하려면 Cloud Storage 버킷에서 앱 원본을 허용 목록에 추가해야 합니다. https://cloud.google.com/storage/docs/configuring-cors도 참조하세요. 이 API는 Node.js에서 사용할 수 없습니다. |
getBytes(ref, maxDownloadSizeBytes) | 개체 위치에 데이터를 다운로드합니다. 개체를 찾을 수 없으면 오류를 반환합니다. 이 기능을 사용하려면 Cloud Storage 버킷에서 앱 원본을 허용 목록에 추가해야 합니다. https://cloud.google.com/storage/docs/configuring-cors도 참조하세요. |
다운로드URL(ref) | 지정된 StorageReference 에 대한 다운로드 URL을 반환합니다. . |
getMetadata(참조) | 이 객체의 메타데이터로 해결되는 Promise . 이 객체가 존재하지 않거나 메타데이터를 검색할 수 없으면 Promise가 거부됩니다. |
getStream(ref, maxDownloadSizeBytes) | 개체 위치에 데이터를 다운로드합니다. 개체를 찾을 수 없으면 오류 이벤트가 발생합니다. 이 API는 Node.js에서만 사용할 수 있습니다. |
목록(참조, 옵션) | 이 저장소 참조 아래에 항목(파일) 및 접두사(폴더)를 나열합니다. List API는 Firebase 규칙 버전 2에서만 사용할 수 있습니다. GCS는 Key-Blob 저장소입니다. Firebase 저장소는 '/'로 구분된 폴더 구조의 의미를 적용합니다. 자세히 알아보려면 GCS의 List API를 참조하세요. Firebase 규칙의 의미 체계를 준수하기 위해 Firebase 저장소는 경로가 '/'로 끝나거나 두 개의 연속된 '/'가 포함된 객체를 지원하지 않습니다. Firebase Storage List API는 지원되지 않는 객체를 필터링합니다. 버킷에 지원되지 않는 객체가 너무 많으면 list()가 실패할 수 있습니다. |
목록모두(ref) | 이 저장소 참조 아래의 모든 항목(파일) 및 접두사(폴더)를 나열합니다. 더 이상 결과가 없을 때까지 list()를 반복적으로 호출하는 도우미 메서드입니다. 기본 페이지 매기기 크기는 1000입니다. 참고: 이 작업이 실행되는 동안 개체가 변경되면 결과가 일관되지 않을 수 있습니다. 경고: 결과가 너무 많으면 listAll 잠재적으로 너무 많은 리소스를 소비할 수 있습니다. |
updateMetadata(참조, 메타데이터) | 이 개체에 대한 메타데이터를 업데이트합니다. |
uploadBytes(참조, 데이터, 메타데이터) | 이 개체의 위치에 데이터를 업로드합니다. 업로드를 재개할 수 없습니다. |
uploadBytesResumable(참조, 데이터, 메타데이터) | 이 개체의 위치에 데이터를 업로드합니다. 업로드는 일시 중지 및 재개될 수 있으며 진행 상황 업데이트가 표시됩니다. |
uploadString(ref, 값, 형식, 메타데이터) | 이 개체의 위치에 문자열을 업로드합니다. 업로드를 재개할 수 없습니다. |
함수(storageOrRef, ...) | |
ref(storageOrRef, 경로) | 기본 버킷의 지정된 경로에 대한 StorageReference를 반환합니다. |
클래스
수업 | 설명 |
---|---|
저장 오류 | Firebase Storage SDK에서 반환된 오류입니다. |
열거
열거 | 설명 |
---|---|
저장소 오류 코드 | StorageError 개체에 첨부할 수 있는 오류 코드입니다. |
인터페이스
상호 작용 | 설명 |
---|---|
Firebase 저장소 | Firebase 저장소 인스턴스. |
전체메타데이터 | 읽기 전용 속성을 포함한 전체 객체 메타데이터 세트입니다. |
목록옵션 | 옵션 list() 허용됩니다. |
목록결과 | list()에서 반환된 결과입니다. |
설정 가능한 메타데이터 | 언제든지 설정할 수 있는 개체 메타데이터입니다. |
스토리지옵저버 | Firebase Storage용 스트림 관찰자입니다. |
스토리지 참조 | Google Cloud Storage 객체에 대한 참조를 나타냅니다. 개발자는 객체를 업로드, 다운로드, 삭제할 수 있을 뿐만 아니라 객체 메타데이터를 가져오거나 설정할 수도 있습니다. |
메타데이터 업로드 | 업로드 시 설정할 수 있는 객체 메타데이터입니다. |
업로드결과 | 재개할 수 없는 업로드에서 결과가 반환되었습니다. |
업로드작업 | 객체를 업로드하는 프로세스를 나타냅니다. 업로드를 모니터링하고 관리할 수 있습니다. |
업로드작업스냅샷 | 업로드 작업의 현재 상태에 대한 데이터를 보유합니다. |
변수
변하기 쉬운 | 설명 |
---|---|
문자열 형식 | 업로드에 가능한 문자열 형식의 열거입니다. |
유형 별칭
유형 별칭 | 설명 |
---|---|
문자열 형식 | 업로드에 가능한 문자열 형식의 열거입니다. |
태스크이벤트 | 작업에서 트리거되는 이벤트입니다. |
태스크상태 | 실행 중인 업로드의 현재 상태를 나타냅니다. |
기능(앱, ...)
getStorage(앱, bucketUrl)
특정 Firebase 앱에 대한 FirebaseStorage 인스턴스를 가져옵니다.
서명:
export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
앱 | Firebase앱 | FirebaseStorage 인스턴스를 가져올 Firebase 앱입니다. |
버킷 URL | 끈 | Firebase 저장소 버킷에 대한 gs:// URL입니다. 통과하지 못한 경우 앱의 기본 저장소 버킷을 사용합니다. |
보고:
FirebaseStorage 인스턴스.
기능(저장, ...)
connectStorageEmulator(스토리지, 호스트, 포트, 옵션)
Cloud Storage 에뮬레이터와 통신하도록 이 FirebaseStorage 인스턴스를 수정하세요.
서명:
export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
저장 | Firebase 저장소 | FirebaseStorage 인스턴스 |
주인 | 끈 | 에뮬레이터 호스트(예: localhost) |
포트 | 숫자 | 에뮬레이터 포트(예: 5001) |
옵션 | { mockUserToken?: EmulatorMockTokenOptions | 끈; } | 에뮬레이터 옵션. options.mockUserToken 은 보안 규칙 단위 테스트에 사용할 모의 인증 토큰입니다. |
보고:
무효의
참조(저장소, URL)
지정된 URL에 대한 StorageReference를 반환합니다.
서명:
export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
저장 | Firebase 저장소 | FirebaseStorage 인스턴스. |
URL | 끈 | URL. 비어 있으면 루트 참조를 반환합니다. |
보고:
함수(참조, ...)
삭제객체(ref)
이 위치의 개체를 삭제합니다.
서명:
export declare function deleteObject(ref: StorageReference): Promise<void>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 삭제할 개체에 대한 StorageReference입니다 . |
보고:
약속<공허>
삭제가 성공하는지 확인하는 Promise
입니다.
getBlob(ref, maxDownloadSizeBytes)
개체 위치에 데이터를 다운로드합니다. 개체를 찾을 수 없으면 오류를 반환합니다.
이 기능을 사용하려면 Cloud Storage 버킷에서 앱 원본을 허용 목록에 추가해야 합니다. https://cloud.google.com/storage/docs/configuring-cors도 참조하세요.
이 API는 Node.js에서 사용할 수 없습니다.
서명:
export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 데이터를 다운로드해야 하는 StorageReference입니다. |
최대다운로드크기바이트 | 숫자 | 설정된 경우 검색할 수 있는 최대 허용 크기(바이트)입니다. |
보고:
약속<블롭>
객체의 바이트를 포함하는 Blob으로 해결되는 Promise
getBytes(ref, maxDownloadSizeBytes)
개체 위치에 데이터를 다운로드합니다. 개체를 찾을 수 없으면 오류를 반환합니다.
이 기능을 사용하려면 Cloud Storage 버킷에서 앱 원본을 허용 목록에 추가해야 합니다. https://cloud.google.com/storage/docs/configuring-cors도 참조하세요.
서명:
export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 데이터를 다운로드해야 하는 StorageReference입니다. |
최대다운로드크기바이트 | 숫자 | 설정된 경우 검색할 수 있는 최대 허용 크기(바이트)입니다. |
보고:
약속<ArrayBuffer>
객체의 바이트를 포함하는 Promise
다운로드URL(ref)
지정된 StorageReference 에 대한 다운로드 URL을 반환합니다. .
서명:
export declare function getDownloadURL(ref: StorageReference): Promise<string>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 다운로드 URL을 가져오기 위한 StorageReference입니다 . |
보고:
약속<문자열>
이 객체의 다운로드 URL로 해결되는 Promise
.
getMetadata(참조)
이 객체의 메타데이터로 해결되는 Promise
. 이 객체가 존재하지 않거나 메타데이터를 검색할 수 없으면 Promise가 거부됩니다.
서명:
export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 메타데이터를 가져올 StorageReference입니다 . |
보고:
약속< FullMetadata >
getStream(ref, maxDownloadSizeBytes)
개체 위치에 데이터를 다운로드합니다. 개체를 찾을 수 없으면 오류 이벤트가 발생합니다.
이 API는 Node.js에서만 사용할 수 있습니다.
서명:
export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 데이터를 다운로드해야 하는 StorageReference입니다. |
최대다운로드크기바이트 | 숫자 | 설정된 경우 검색할 수 있는 최대 허용 크기(바이트)입니다. |
보고:
NodeJS.ReadableStream
객체의 데이터를 바이트로 포함하는 스트림
목록(참조, 옵션)
이 저장소 참조 아래에 항목(파일) 및 접두사(폴더)를 나열합니다.
List API는 Firebase 규칙 버전 2에서만 사용할 수 있습니다.
GCS는 Key-Blob 저장소입니다. Firebase 저장소는 '/'로 구분된 폴더 구조의 의미를 적용합니다. 자세히 알아보려면 GCS의 List API를 참조하세요.
Firebase 규칙의 의미 체계를 준수하기 위해 Firebase 저장소는 경로가 '/'로 끝나거나 두 개의 연속된 '/'가 포함된 객체를 지원하지 않습니다. Firebase Storage List API는 지원되지 않는 객체를 필터링합니다. 버킷에 지원되지 않는 객체가 너무 많으면 list()가 실패할 수 있습니다.
서명:
export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 목록을 가져올 StorageReference입니다 . |
옵션 | 목록옵션 | 자세한 내용은 ListOptions를 참조하세요. |
보고:
약속< 목록결과 >
항목과 접두사로 해결되는 Promise
. prefixes
에는 하위 폴더에 대한 참조가 포함되어 있고 items
에는 이 폴더의 개체에 대한 참조가 포함되어 있습니다. nextPageToken
사용하여 나머지 결과를 얻을 수 있습니다.
목록모두(ref)
이 저장소 참조 아래의 모든 항목(파일) 및 접두사(폴더)를 나열합니다.
더 이상 결과가 없을 때까지 list()를 반복적으로 호출하는 도우미 메서드입니다. 기본 페이지 매기기 크기는 1000입니다.
서명:
export declare function listAll(ref: StorageReference): Promise<ListResult>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 목록을 가져올 StorageReference입니다 . |
보고:
약속< 목록결과 >
현재 저장소 참조 아래의 모든 항목과 접두사로 해결되는 Promise
. prefixes
에는 하위 디렉터리에 대한 참조가 포함되어 있고 items
에는 이 폴더의 개체에 대한 참조가 포함되어 있습니다. nextPageToken
은 반환되지 않습니다.
updateMetadata(참조, 메타데이터)
이 개체에 대한 메타데이터를 업데이트합니다.
서명:
export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 메타데이터를 업데이트하기 위한 StorageReference입니다 . |
메타데이터 | 설정 가능한 메타데이터 | 개체의 새 메타데이터입니다. 명시적으로 설정된 값만 변경됩니다. 값을 명시적으로 null로 설정하면 메타데이터가 제거됩니다. |
보고:
약속< FullMetadata >
이 객체에 대한 새 메타데이터로 해결되는 Promise
.
uploadBytes(참조, 데이터, 메타데이터)
이 개체의 위치에 데이터를 업로드합니다. 업로드를 재개할 수 없습니다.
서명:
export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 데이터를 업로드해야 하는 StorageReference입니다 . |
데이터 | 블롭 | Uint8Array | 배열버퍼 | 업로드할 데이터입니다. |
메타데이터 | 메타데이터 업로드 | 업로드할 데이터의 메타데이터입니다. |
보고:
약속< UploadResult >
UploadResult를 포함하는 Promise
uploadBytesResumable(참조, 데이터, 메타데이터)
이 개체의 위치에 데이터를 업로드합니다. 업로드는 일시 중지 및 재개될 수 있으며 진행 상황 업데이트가 표시됩니다.
서명:
export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 데이터를 업로드해야 하는 StorageReference입니다 . |
데이터 | 블롭 | Uint8Array | 배열버퍼 | 업로드할 데이터입니다. |
메타데이터 | 메타데이터 업로드 | 업로드할 데이터의 메타데이터입니다. |
보고:
UploadTask
uploadString(ref, 값, 형식, 메타데이터)
이 개체의 위치에 문자열을 업로드합니다. 업로드를 재개할 수 없습니다.
서명:
export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
심판 | 스토리지 참조 | 문자열을 업로드해야 하는 StorageReference 입니다. |
값 | 끈 | 업로드할 문자열입니다. |
체재 | 문자열 형식 | 업로드할 문자열의 형식입니다. |
메타데이터 | 메타데이터 업로드 | 업로드할 문자열의 메타데이터입니다. |
보고:
약속< UploadResult >
UploadResult를 포함하는 Promise
함수(storageOrRef, ...)
ref(storageOrRef, 경로)
기본 버킷의 지정된 경로에 대한 StorageReference를 반환합니다.
서명:
export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
저장 또는 참조 | Firebase 저장소 | 스토리지 참조 | 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';
태스크상태
실행 중인 업로드의 현재 상태를 나타냅니다.
서명:
export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
저장소 오류 코드
StorageError
개체에 첨부할 수 있는 오류 코드입니다.
서명:
export declare enum StorageErrorCode
열거형 멤버
회원 | 값 | 설명 |
---|---|---|
앱_삭제됨 | "app-deleted" | |
버킷_NOT_FOUND | "bucket-not-found" | |
취소 된 | "canceled" | |
CANNOT_SLICE_BLOB | "cannot-slice-blob" | |
내부_ERROR | "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" | |
잘못된 URL | "invalid-url" | |
NO_DEFAULT_BUCKET | "no-default-bucket" | |
NO_DOWNLOAD_URL | "no-download-url" | |
OBJECT_NOT_FOUND | "object-not-found" | |
프로젝트_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" |