DocumentMask

google.firestore.v1. DocumentMask

Represents a DocumentMask.

Constructor

new DocumentMask(propertiesopt)

Constructs a new DocumentMask.

Parameters:
Name Type Attributes Description
properties google.firestore.v1.IDocumentMask <optional>

Properties to set

Implements:
  • IDocumentMask

Members

fieldPaths

DocumentMask fieldPaths.

Methods

(static) fromObject(object) → {google.firestore.v1.DocumentMask}

Creates a DocumentMask message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.firestore.v1.DocumentMask

DocumentMask

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a DocumentMask message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.firestore.v1.DocumentMask

DocumentMask

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

toJSON() → {Object.<string, *>}

Converts this DocumentMask to JSON.

Returns:
Type Description
Object.<string, *>

JSON object