forceCalendar
API Reference

EventSearch

API reference for the EventSearch class.

import { EventSearch } from '@forcecalendar/core';

Constructor

new EventSearch(eventStore: EventStore)

Methods

MethodSignatureReturns
search(query: string, options?: SearchOptions) => Event[]Matching events
filter(filters: FilterOptions) => Event[]Filtered events
advancedSearch(query: string, filters?: FilterOptions, options?: SearchOptions) => Event[]Combined results
getSuggestions(partial: string, options?: { field?, limit? }) => string[]Suggestions
getUniqueValues(field: string) => string[]Unique values
groupBy(field: string, options?: object) => objectGrouped events
rebuildIndex() => void

SearchOptions

OptionTypeDefault
fieldsstring[]['title', 'description', 'location']
fuzzybooleanfalse
caseSensitivebooleanfalse
limitnumber50
sortBystring'relevance'

FilterOptions

OptionType
dateRange{ start: Date, end: Date }
categoriesstring[]
locationsstring[]
attendeesstring[]
statusstring[]
allDayboolean
recurringboolean
hasRemindersboolean
custom(event: Event) => boolean