Back to Firebase Js Sdk

ObjectSchema class

docs-devsite/ai.objectschema.md

12.12.11.9 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 %}

ObjectSchema class

Schema class for "object" types. The properties param must be a map of Schema objects.

<b>Signature:</b>

typescript
export declare class ObjectSchema extends Schema 

<b>Extends:</b> Schema

Constructors

ConstructorModifiersDescription
(constructor)(schemaParams, properties, optionalProperties)Constructs a new instance of the <code>ObjectSchema</code> class

Properties

PropertyModifiersTypeDescription
optionalPropertiesstring[]
properties{ [k: string]: TypedSchema<!-- -->; }

ObjectSchema.(constructor)

Constructs a new instance of the ObjectSchema class

<b>Signature:</b>

typescript
constructor(schemaParams: SchemaParams, properties: {
        [k: string]: TypedSchema;
    }, optionalProperties?: string[]);

Parameters

ParameterTypeDescription
schemaParamsSchemaParams
properties{ [k: string]: TypedSchema<!-- -->; }
optionalPropertiesstring[]

ObjectSchema.optionalProperties

<b>Signature:</b>

typescript
optionalProperties: string[];

ObjectSchema.properties

<b>Signature:</b>

typescript
properties: {
        [k: string]: TypedSchema;
    };