@coveo/headless
    Preparing search index...

    Interface FieldDescription

    Field description

    interface FieldDescription {
        defaultValue: string;
        description: string;
        fieldSourceType: string;
        fieldType: string;
        groupByField: boolean;
        includeInQuery: boolean;
        includeInResults: boolean;
        name: string;
        sortByField: boolean;
        splitGroupByField: boolean;
        type: string;
    }
    Index

    Properties

    defaultValue description fieldSourceType fieldType groupByField includeInQuery includeInResults name sortByField splitGroupByField type

    Properties

    defaultValue: string

    The default value of the field.

    description: string

    A modest description of the field.

    fieldSourceType: string

    The fieldSourceType.

    fieldType: string

    The fieldType (eg., Date, Double, Integer, LargeString, Long, SmallString).

    groupByField: boolean

    Whether the field is considered groupBy (facet).

    includeInQuery: boolean

    Whether the field can be referenced in a query.

    includeInResults: boolean

    Whether the field is returned with results.

    name: string

    The field name.

    sortByField: boolean

    Whether the field can be used to sort results.

    splitGroupByField: boolean

    Whether the field is considered splitGroupBy (ie., facet with values delimited by ;).

    type: string

    The field type.

    Settings

    Member Visibility

    On This Page

    Properties