firebase-js-sdk/docs-devsite/storage.settablemetadata.md

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.

Signature:

export interface SettableMetadata 

Properties

Property	Type	Description
cacheControl	string | undefined	Served as the 'Cache-Control' header on object download.
contentDisposition	string | undefined	Served as the 'Content-Disposition' header on object download.
contentEncoding	string | undefined	Served as the 'Content-Encoding' header on object download.
contentLanguage	string | undefined	Served as the 'Content-Language' header on object download.
contentType	string | undefined	Served as the 'Content-Type' header on object download.
customMetadata	{ [key: string]: string; } | undefined	Additional user-defined custom metadata.

SettableMetadata.cacheControl

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

Signature:

cacheControl?: string | undefined;

SettableMetadata.contentDisposition

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

Signature:

contentDisposition?: string | undefined;

SettableMetadata.contentEncoding

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

Signature:

contentEncoding?: string | undefined;

SettableMetadata.contentLanguage

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

Signature:

contentLanguage?: string | undefined;

SettableMetadata.contentType

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

Signature:

contentType?: string | undefined;

SettableMetadata.customMetadata

Additional user-defined custom metadata.

Signature:

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