Interface SearchOptions

interface SearchOptions {
    enterpriseCategories?: {
        fields?: {
            description?: boolean;
            "locations.name"?: boolean;
            name?: boolean;
        };
        limit?: number;
    };
    enterpriseLocations?: {
        fields?: { description?: boolean; name?: boolean; tags?: boolean };
        limit?: number;
    };
    places?: {
        fields?: { description?: boolean; name?: boolean };
        limit?: number;
    };
}

Properties

enterpriseCategories? enterpriseLocations? places?

Properties

OptionalenterpriseCategories

enterpriseCategories?: {
    fields?: {
        description?: boolean;
        "locations.name"?: boolean;
        name?: boolean;
    };
    limit?: number;
} = ...

Options for searching categories.

Type declaration

  • Optionalfields?: { description?: boolean; "locations.name"?: boolean; name?: boolean }

    Fields to search in categories.

    • Optionaldescription?: boolean

      Enable searching by category description

    • Optionallocations.name?: boolean

      Enable searching by names of locations within the category

    • Optionalname?: boolean

      Enable searching by category name

  • Optionallimit?: number

    Maximum number of category results to return

OptionalenterpriseLocations

enterpriseLocations?: {
    fields?: { description?: boolean; name?: boolean; tags?: boolean };
    limit?: number;
} = ...

Options for searching locations.

Type declaration

  • Optionalfields?: { description?: boolean; name?: boolean; tags?: boolean }

    Fields to search in locations.

    • Optionaldescription?: boolean

      Enable searching by location description

    • Optionalname?: boolean

      Enable searching by location name

    • Optionaltags?: boolean

      Enable searching by location tags

  • Optionallimit?: number

    Maximum number of location results to return

Optionalplaces

places?: { fields?: { description?: boolean; name?: boolean }; limit?: number } = ...

Options for searching places.

Type declaration

  • Optionalfields?: { description?: boolean; name?: boolean }

    Fields to search in places.

    • Optionaldescription?: boolean

      Enable searching by place description

    • Optionalname?: boolean

      Enable searching by place name

  • Optionallimit?: number

    Maximum number of place results to return

Settings

Member Visibility

On This Page

Properties