React Native Firebase
    Preparing search index...

    Interface SchemaParams

    Params passed to Schema static methods to create specific Schema classes.

    interface SchemaParams {
        description?: string;
        enum?: string[];
        example?: unknown;
        format?: string;
        items?: SchemaInterface;
        maximum?: number;
        maxItems?: number;
        minimum?: number;
        minItems?: number;
        nullable?: boolean;
        properties?: { [k: string]: SchemaInterface };
        propertyOrdering?: string[];
        title?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    description? enum? example? format? items? maximum? maxItems? minimum? minItems? nullable? properties? propertyOrdering? title?

    Properties

    description?: string

    Optional. The description of the property.

    enum?: string[]

    Optional. The enum of the property.

    example?: unknown

    Optional. The example of the property.

    format?: string

    Optional. The format of the property. When using the Gemini Developer API (GoogleAIBackend), this must be either 'enum' or 'date-time', otherwise requests will fail.

    items?: SchemaInterface

    Optional. The items of the property.

    maximum?: number

    The maximum value of a numeric type.

    maxItems?: number

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

    minimum?: number

    The minimum value of a numeric type.

    minItems?: number

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

    nullable?: boolean

    Optional. Whether the property is nullable.

    properties?: { [k: string]: SchemaInterface }

    Optional. Map of Schema objects.

    propertyOrdering?: string[]

    A hint suggesting the order in which the keys should appear in the generated JSON string.

    title?: string

    The title of the property. This helps document the schema's purpose but does not typically constrain the generated value. It can subtly guide the model by clarifying the intent of a field.

    Settings

    Member Visibility

    On This Page

    Properties