storage package

Облачное хранилище для Firebase

Функции

Функция	Описание
функция (приложение, ...)
getStorage (приложение, BucketUrl)	Получает экземпляр FirebaseStorage для данного приложения Firebase.
функция (хранилище, ...)
ConnectStorageEmulator (хранилище, хост, порт, параметры)	Измените этот экземпляр FirebaseStorage для связи с эмулятором Cloud Storage.
ref(хранилище, URL)	Возвращает StorageReference для данного URL-адреса.
функция(ссылка, ...)
удалитьОбъект (ссылка)	Удаляет объект в этом месте.
getBlob (ссылка, maxDownloadSizeBytes)	Загружает данные по местоположению объекта. Возвращает ошибку, если объект не найден. Чтобы использовать эту функцию, вам необходимо внести источник вашего приложения в белый список в корзине Cloud Storage. См. также https://cloud.google.com/storage/docs/configuring-cors. Этот API недоступен в Node.
getBytes (ссылка, maxDownloadSizeBytes)	Загружает данные по местоположению объекта. Возвращает ошибку, если объект не найден. Чтобы использовать эту функцию, вам необходимо внести источник вашего приложения в белый список в корзине Cloud Storage. См. также https://cloud.google.com/storage/docs/configuring-cors.
getDownloadURL (ссылка)	Возвращает URL-адрес загрузки для данного StorageReference. .
получить метаданные (ссылка)	Promise , которое разрешается с метаданными для этого объекта. Если этот объект не существует или метаданные невозможно получить, обещание отклоняется.
getStream (ссылка, maxDownloadSizeBytes)	Загружает данные по местоположению объекта. Вызывает событие ошибки, если объект не найден. Этот API доступен только в Node.
список (ссылка, параметры)	Перечислите элементы (файлы) и префиксы (папки) по этой ссылке на хранилище. List API доступен только для правил Firebase версии 2. GCS — это хранилище ключей. Firebase Storage накладывает семантику структуры папок, разделенной '/'. Если вы хотите узнать больше, обратитесь к API списка GCS. Чтобы соответствовать семантике правил Firebase, Firebase Storage не поддерживает объекты, пути которых заканчиваются на «/» или содержат два последовательных символа «/». API списка хранилищ Firebase будет фильтровать эти неподдерживаемые объекты. list() может завершиться ошибкой, если в сегменте слишком много неподдерживаемых объектов.
списокВсе (ссылка)	Перечислите все элементы (файлы) и префиксы (папки) по этой ссылке на хранилище. Это вспомогательный метод для многократного вызова list() до тех пор, пока не исчезнут результаты. Размер пагинации по умолчанию — 1000. Примечание. Результаты могут быть несогласованными, если объекты изменяются во время выполнения этой операции. Предупреждение: listAll потенциально может потреблять слишком много ресурсов, если результатов слишком много.
updateMetadata (ссылка, метаданные)	Обновляет метаданные для этого объекта.
uploadBytes (ссылка, данные, метаданные)	Загружает данные в местоположение этого объекта. Загрузка не возобновляется.
uploadBytesResumable (ссылка, данные, метаданные)	Загружает данные в местоположение этого объекта. Загрузку можно приостановить и возобновить, а также отображать обновления о ходе выполнения.
uploadString (ссылка, значение, формат, метаданные)	Загружает строку в местоположение этого объекта. Загрузка не возобновляется.
функция (хранилищеOrRef, ...)
ref(хранилищеOrRef, путь)	Возвращает StorageReference для заданного пути в сегменте по умолчанию.

Классы

Сорт	Описание
Ошибка хранения	Ошибка, возвращаемая Firebase Storage SDK.

Перечисления

Перечисление	Описание
Хранилидерроркоде	Коды ошибок, которые можно прикрепить к объектам StorageError .

Интерфейсы

Интерфейс	Описание
FirebaseStorage	Экземпляр Firebase Storage.
Полные метаданные	Полный набор метаданных объекта, включая свойства, доступные только для чтения.
Список опций	list() принимает.
Списокрезультат	Результат, возвращаемый list().
SettableMetadata	Метаданные объекта, которые можно установить в любое время.
ХранилищеОбсервер	Наблюдатель потока для Firebase Storage.
Ссылка на хранилище	Представляет ссылку на объект Google Cloud Storage. Разработчики могут загружать, скачивать и удалять объекты, а также получать/устанавливать метаданные объектов.
Загрузить метаданные	Метаданные объекта, которые можно задать при загрузке.
Загрузитьрезультат	Результат возвращен из невозобновляемой загрузки.
Загрузить задачу	Представляет процесс загрузки объекта. Позволяет отслеживать и управлять загрузкой.
Загрузить снимок задачи	Содержит данные о текущем состоянии задачи загрузки.

Переменные

Переменная	Описание
Строковый формат	Перечисление возможных форматов строк для загрузки.

Введите псевдонимы

Введите псевдоним	Описание
Строковый формат	Перечисление возможных форматов строк для загрузки.
TaskEvent	Событие, которое инициируется задачей.
Таскстате	Представляет текущее состояние выполняемой загрузки.

функция (приложение, ...)

getStorage (приложение, BucketUrl)

Получает экземпляр FirebaseStorage для данного приложения Firebase.

Подпись:

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

Параметры

Параметр	Тип	Описание
приложение	FirebaseApp	Приложение Firebase, для которого нужно получить экземпляр FirebaseStorage .
URL-адрес ведра	нить	URL-адрес gs:// вашего сегмента хранилища Firebase. Если не передано, используется сегмент хранилища приложения по умолчанию.

Возврат:

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(хранилище, URL)

Возвращает StorageReference для данного URL-адреса.

Подпись:

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

Параметры

Параметр	Тип	Описание
хранилище	FirebaseStorage	Экземпляр FirebaseStorage .
URL	нить	URL-адрес. Если пусто, возвращает корневую ссылку.

Возврат:

Ссылка на хранилище

функция(ссылка, ...)

удалитьОбъект (ссылка)

Удаляет объект в этом месте.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference для объекта, который нужно удалить.

Возврат:

Обещание<void>

Promise , которое выполняется в случае успешного удаления.

getBlob (ссылка, maxDownloadSizeBytes)

Загружает данные по местоположению объекта. Возвращает ошибку, если объект не найден.

Чтобы использовать эту функцию, вам необходимо внести источник вашего приложения в белый список в корзине Cloud Storage. См. также https://cloud.google.com/storage/docs/configuring-cors.

Этот API недоступен в Node.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference, куда следует загрузить данные.
maxDownloadSizeBytes	число	Если установлено, максимально допустимый размер в байтах для получения.

Возврат:

Обещание<Blob>

Обещание, которое разрешается с помощью Blob, содержащего байты объекта.

getBytes (ссылка, maxDownloadSizeBytes)

Загружает данные по местоположению объекта. Возвращает ошибку, если объект не найден.

Чтобы использовать эту функцию, вам необходимо внести источник вашего приложения в белый список в корзине Cloud Storage. См. также https://cloud.google.com/storage/docs/configuring-cors.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference, куда следует загрузить данные.
maxDownloadSizeBytes	число	Если установлено, максимально допустимый размер в байтах для получения.

Возврат:

Обещание<ArrayBuffer>

Обещание, содержащее байты объекта

getDownloadURL (ссылка)

Возвращает URL-адрес загрузки для данного StorageReference. .

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference , для которого нужно получить URL-адрес загрузки.

Возврат:

Обещание<строка>

Promise , которое разрешается с помощью URL-адреса загрузки для этого объекта.

получить метаданные (ссылка)

Promise , которое разрешается с метаданными для этого объекта. Если этот объект не существует или метаданные невозможно получить, обещание отклоняется.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference , из которого можно получить метаданные.

Возврат:

Обещание < FullMetadata >

getStream (ссылка, maxDownloadSizeBytes)

Загружает данные по местоположению объекта. Вызывает событие ошибки, если объект не найден.

Этот API доступен только в Node.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference, куда следует загрузить данные.
maxDownloadSizeBytes	число	Если установлено, максимально допустимый размер в байтах для получения.

Возврат:

Читаемый поток

Поток с данными объекта в байтах.

список (ссылка, параметры)

Перечислите элементы (файлы) и префиксы (папки) по этой ссылке на хранилище.

List API доступен только для правил Firebase версии 2.

GCS — это хранилище ключей. Firebase Storage накладывает семантику структуры папок, разделенной '/'. Если вы хотите узнать больше, обратитесь к API списка GCS.

Чтобы соответствовать семантике правил Firebase, Firebase Storage не поддерживает объекты, пути которых заканчиваются на «/» или содержат два последовательных символа «/». API списка хранилищ Firebase будет фильтровать эти неподдерживаемые объекты. list() может завершиться ошибкой, если в сегменте слишком много неподдерживаемых объектов.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference , из которого нужно получить список.
параметры	Список опций	Подробности смотрите в ListOptions .

Возврат:

Обещание < ListResult >

Promise , которое разрешается с помощью элементов и префиксов. prefixes содержат ссылки на подпапки, а items содержат ссылки на объекты в этой папке. nextPageToken можно использовать для получения остальных результатов.

списокВсе (ссылка)

Перечислите все элементы (файлы) и префиксы (папки) по этой ссылке на хранилище.

Это вспомогательный метод для многократного вызова list() до тех пор, пока не исчезнут результаты. Размер пагинации по умолчанию — 1000.

Примечание. Результаты могут быть несогласованными, если объекты изменяются во время выполнения этой операции.

Предупреждение: listAll потенциально может потреблять слишком много ресурсов, если результатов слишком много.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference , из которого нужно получить список.

Возврат:

Обещание < ListResult >

Promise , которое разрешается со всеми элементами и префиксами по текущей ссылке на хранилище. prefixes содержат ссылки на подкаталоги, а items содержат ссылки на объекты в этой папке. nextPageToken никогда не возвращается.

updateMetadata (ссылка, метаданные)

Обновляет метаданные для этого объекта.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference для обновления метаданных.
метаданные	SettableMetadata	Новые метаданные для объекта. Будут изменены только те значения, которые были заданы явно. Явная установка значения null приведет к удалению метаданных.

Возврат:

Обещание < FullMetadata >

Promise , которое разрешается с использованием новых метаданных для этого объекта.

uploadBytes (ссылка, данные, метаданные)

Загружает данные в местоположение этого объекта. Загрузка не возобновляется.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference , куда следует загрузить данные.
данные	Блоб | Uint8Array | МассивБуфер	Данные для загрузки.
метаданные	Загрузить метаданные	Метаданные для данных для загрузки.

Возврат:

Обещание < Результат загрузки >

Обещание, содержащее UploadResult

uploadBytesResumable (ссылка, данные, метаданные)

Загружает данные в местоположение этого объекта. Загрузку можно приостановить и возобновить, а также отображать обновления о ходе выполнения.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference , куда следует загрузить данные.
данные	Блоб | Uint8Array | МассивБуфер	Данные для загрузки.
метаданные	Загрузить метаданные	Метаданные для данных для загрузки.

Возврат:

Загрузить задачу

Задача загрузки

uploadString (ссылка, значение, формат, метаданные)

Загружает строку в местоположение этого объекта. Загрузка не возобновляется.

Подпись:

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

Параметры

Параметр	Тип	Описание
ссылка	Ссылка на хранилище	StorageReference , куда следует загрузить строку.
ценить	нить	Строка для загрузки.
формат	Строковый формат	Формат строки для загрузки.
метаданные	Загрузить метаданные	Метаданные для загружаемой строки.

Возврат:

Обещание < Результат загрузки >

Обещание, содержащее UploadResult

функция (хранилищеOrRef, ...)

ref(хранилищеOrRef, путь)

Возвращает StorageReference для заданного пути в сегменте по умолчанию.

Подпись:

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

Параметры

Параметр	Тип	Описание
хранилищеOrRef	FirebaseStorage | Ссылка на хранилище	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];

TaskEvent

Событие, которое инициируется задачей.

Подпись:

export declare type TaskEvent = 'state_changed';

Таскстате

Представляет текущее состояние выполняемой загрузки.

Подпись:

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

Хранилидерроркоде

Коды ошибок, которые можно прикрепить к объектам StorageError .

Подпись:

export declare enum StorageErrorCode 

Члены перечисления

Член	Ценить	Описание
ПРИЛОЖЕНИЕ_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"
ПРОЕКТ_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"