React Native Firebase
    Preparing search index...

    Class ObjectSchema

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

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown

      Allows user to add other schema properties that have not yet been officially added to the SDK.

    Index

    Constructors

    constructor

    Methods

    toJSON array boolean enumString integer number object string

    Properties

    description? example? format? items? maxItems? minItems? nullable optionalProperties properties type

    Constructors

    Methods

    Properties

    description?: string

    Optional. The description of the property.

    example?: unknown

    Optional. The example of the property.

    format?: string

    Optional. The format of the property. Supported formats:

    • for NUMBER type: "float", "double"
    • for INTEGER type: "int32", "int64"
    • for STRING type: "email", "byte", etc
    items?: SchemaInterface

    Optional. The items of the property.

    maxItems?: number

    The maximum number of items (elements) in a schema of type SchemaType.ARRAY.

    minItems?: number

    The minimum number of items (elements) in a schema of type SchemaType.ARRAY.

    nullable: boolean

    Optional. Whether the property is nullable. Defaults to false.

    optionalProperties: string[] = []
    properties: { [k: string]: TypedSchema }
    type: SchemaType

    Optional. The type of the property. SchemaType.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties