functional-models
    Preparing search index...

    Interface InnerBuilderV2

    A builder for version 3.0 search queries.

    interface InnerBuilderV2 {
        complex: (subBuilderFunc: SubBuilderFunction) => BuilderV2Link;
        datesAfter: (
            key: string,
            jsDate: string | Date,
            options?: { equalToAndAfter?: boolean; valueType?: DatastoreValueType },
        ) => BuilderV2Link;
        datesBefore: (
            key: string,
            jsDate: string | Date,
            options?: { equalToAndBefore?: boolean; valueType?: DatastoreValueType },
        ) => BuilderV2Link;
        property: (
            key: string,
            value: any,
            options?: Partial<PropertyOptions>,
        ) => BuilderV2Link;
    }
    Index

    Properties

    complex datesAfter datesBefore property

    Properties

    complex: (subBuilderFunc: SubBuilderFunction) => BuilderV2Link

    Creates a query that has nested property queries.

    Type declaration

    datesAfter: (
        key: string,
        jsDate: string | Date,
        options?: { equalToAndAfter?: boolean; valueType?: DatastoreValueType },
    ) => BuilderV2Link

    Searches for elements that are after the given date. NOTE: It can be very important to set the valueType to either string or Date depending on what datastore you are using.

    Type declaration

      • (
            key: string,
            jsDate: string | Date,
            options?: { equalToAndAfter?: boolean; valueType?: DatastoreValueType },
        ): BuilderV2Link

      • Parameters

        • key: string

          The property name/key to use.

        • jsDate: string | Date

          The date to search.

        • Optionaloptions: { equalToAndAfter?: boolean; valueType?: DatastoreValueType }

          Additional options.

        Returns BuilderV2Link

    datesBefore: (
        key: string,
        jsDate: string | Date,
        options?: { equalToAndBefore?: boolean; valueType?: DatastoreValueType },
    ) => BuilderV2Link

    Searches for elements that are before the given date. NOTE: It can be very important to set the valueType to either string or Date depending on what datastore you are using.

    Type declaration

      • (
            key: string,
            jsDate: string | Date,
            options?: { equalToAndBefore?: boolean; valueType?: DatastoreValueType },
        ): BuilderV2Link

      • Parameters

        • key: string

          The property name/key to use.

        • jsDate: string | Date

          The date to search.

        • Optionaloptions: { equalToAndBefore?: boolean; valueType?: DatastoreValueType }

          Additional options.

        Returns BuilderV2Link

    property: (
        key: string,
        value: any,
        options?: Partial<PropertyOptions>,
    ) => BuilderV2Link

    Search a value

    Type declaration

    Settings

    Member Visibility

    On This Page

    Properties