Back to Firebase Js Sdk

SettableMetadata interface

docs-devsite/storage.settablemetadata.md

12.12.12.5 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

SettableMetadata interface

Object metadata that can be set at any time.

<b>Signature:</b>

typescript
export interface SettableMetadata 

Properties

PropertyTypeDescription
cacheControlstring | undefinedServed as the 'Cache-Control' header on object download.
contentDispositionstring | undefinedServed as the 'Content-Disposition' header on object download.
contentEncodingstring | undefinedServed as the 'Content-Encoding' header on object download.
contentLanguagestring | undefinedServed as the 'Content-Language' header on object download.
contentTypestring | undefinedServed as the 'Content-Type' header on object download.
customMetadata{ [key: string]: string; } | undefinedAdditional user-defined custom metadata.

SettableMetadata.cacheControl

Served as the 'Cache-Control' header on object download.

<b>Signature:</b>

typescript
cacheControl?: string | undefined;

SettableMetadata.contentDisposition

Served as the 'Content-Disposition' header on object download.

<b>Signature:</b>

typescript
contentDisposition?: string | undefined;

SettableMetadata.contentEncoding

Served as the 'Content-Encoding' header on object download.

<b>Signature:</b>

typescript
contentEncoding?: string | undefined;

SettableMetadata.contentLanguage

Served as the 'Content-Language' header on object download.

<b>Signature:</b>

typescript
contentLanguage?: string | undefined;

SettableMetadata.contentType

Served as the 'Content-Type' header on object download.

<b>Signature:</b>

typescript
contentType?: string | undefined;

SettableMetadata.customMetadata

Additional user-defined custom metadata.

<b>Signature:</b>

typescript
customMetadata?: {
        [key: string]: string;
    } | undefined;