Back to Firebase Js Sdk

ObjectSchemaRequest interface

docs-devsite/ai.objectschemarequest.md

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

ObjectSchemaRequest interface

Interface for JSON parameters in a schema of SchemaType "object" when not using the Schema.object() helper.

<b>Signature:</b>

typescript
export interface ObjectSchemaRequest extends SchemaRequest 

<b>Extends:</b> SchemaRequest

Properties

PropertyTypeDescription
optionalPropertiesneverThis is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the <code>Schema.object()</code> helper method. Populating this property will cause response errors if the object is not wrapped with <code>Schema.object()</code>.
type'object'

ObjectSchemaRequest.optionalProperties

This is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the Schema.object() helper method. Populating this property will cause response errors if the object is not wrapped with Schema.object()<!-- -->.

<b>Signature:</b>

typescript
optionalProperties?: never;

ObjectSchemaRequest.type

<b>Signature:</b>

typescript
type: 'object';