Documentation
Static article pages
Use the interactive search on the home page, or browse documentation entries directly below.
Analyzer and Tokenization Deep Dive
Understand how tokenization and token filters change matching behavior, recall, and precision.
AnalysisAnalyzers, Tokenizers, and Filters
Normalization is explicit, so you can tailor indexing and querying behavior per field.
Other FeaturesApproximate Nearest Neighbor Vector Search
Use VectorFieldIndex and bigramVector for lightweight semantic-ish lookup.
Demo InternalsArticle Length Facets in the Demo
How the demo calculates article word count, builds numeric buckets, and turns them into live sidebar filters.
Demo InternalsAsk the Docs End to End
How the demo builds semantic embeddings, ships them to the browser, and answers natural-language questions locally.
DiscoveryAvg Aggregation
Compute the arithmetic mean of indexed numeric or date values, optionally within the current result set.
Lexical QueryingBoolQuery for Must, Should, Filter, MustNot, and MinimumShouldMatch
Blend ranking clauses with strict filters, exclusions, and optional should-logic in one request.
Lexical QueryingBoostingQuery for Soft Demotion Instead of Hard Exclusion
Keep relevant documents in the results while pushing down candidates that carry undesirable signals.
GuidesBuild Interactive ECharts Dashboards from Plain JSON
Use Querylight TS to turn plain JSON records into the filtered series and buckets that Apache ECharts expects.
SchemaChoosing a Schema for Search
Model titles, body text, filters, tags, and helper fields so search behavior stays predictable.
OverviewComparing Querylight TS to Other Browser Search Libraries
A practical overview of strengths and weak points for Querylight TS, Fuse.js, Lunr, MiniSearch, FlexSearch, Pagefind, and Orama.
DiscoveryDate Histogram Aggregation
Bucket date fields into fixed-width time intervals for timelines and recency views.
Lexical QueryingDisMaxQuery for Best-Field Matching with Tie Breakers
Prefer the strongest matching clause while still giving partial credit to secondary matches.
RankingDistanceFeatureQuery for Recency and Numeric Closeness
Boost documents by how close a numeric or date field is to an origin value.
Other FeaturesDocument Chunking Strategies
Split long documents into meaningful sections so lexical retrieval, highlighting, and vector search stay focused.
OverviewDocumentation Index
A section-by-section map of the Querylight TS documentation.
GuidesFrom Raw API Payloads to Browser Dashboards
A practical pattern for turning raw API responses into local-first dashboard interactions with Querylight TS.
Other FeaturesGeo Indexing with Points and Polygons
Store GeoJSON and query by point containment or polygon intersection.
OverviewGetting Started with Browser Search
Build a practical search box quickly with either the beginner helper or the equivalent manual setup.
Other FeaturesHighlighting with Querylight TS
Generate exact, phrase, prefix, and fuzzy highlight fragments after retrieval using stored source offsets.
DiscoveryHistogram Aggregation
Bucket numeric fields into regular fixed-width intervals for charts and sidebar facets.
Demo InternalsHow the Aggregations Sidebar Works
How the demo calculates live text facets, word-count buckets, and significant terms for the right-hand sidebar.
GuidesHow To Build Autocomplete
Use prefix-friendly fields, compact suggestion text, and stable ranking for search-as-you-type.
GuidesHow To Build Faceted Navigation
Use text, numeric, and date aggregations over the current hit set to drive filters, counts, and exploratory navigation.
OverviewIntroducing Querylight TS
Why this TypeScript port exists, who it is for, and where it fits relative to established search tools.
Demo InternalsLazy Indexing in the Dashboard Demo
How the dashboard route delays index construction until a section is actually viewed.
DiscoveryMax Aggregation
Get the largest indexed numeric or date value, optionally restricted to the current result set.
DiscoveryMin Aggregation
Get the smallest indexed numeric or date value, optionally restricted to the current result set.
DiscoveryNumeric and Date Aggregations
A map of the numeric and date aggregation helpers available on NumericFieldIndex and DateFieldIndex.
IndexingNumericFieldIndex and DateFieldIndex for Structured Features
Map numeric and date fields explicitly so range queries, ranking features, and aggregations behave predictably.
OverviewOther Work Related to Querylight TS
A map of adjacent projects by Jilles van Gurp around search, ranking, Elasticsearch, geo, and DSL tooling.
OperationsPerformance and Memory Tuning
Control index size and query cost by choosing fields, analyzers, and precomputation strategies carefully.
Lexical QueryingPhrase Search and Slop
Match analyzed terms in sequence, with optional movement tolerance.
IndexingPortable JSON Index State
Serialize index structures and hydrate them again without reindexing.
DiscoveryRange Aggregation
Bucket numeric or date fields into explicit ranges for faceting and filtered navigation.
Lexical QueryingRangeQuery Over Lexical Fields
Filter sortable string terms with gt, gte, lt, and lte boundaries.
RankingRankFeatureQuery for Numeric Relevance Signals
Boost documents with numeric features such as popularity, clicks, or quality scores.
GuidesReal-World Recipes
Practical patterns for docs search, blog search, product filtering, related content, and lightweight semantic retrieval.
RankingReciprocal Rank Fusion
Combine multiple ranked result lists from lexical, filtered, geo, or vector search.
Lexical QueryingRegexpQuery for Term-Level Regular Expressions
Match indexed terms with JavaScript regular expressions when wildcard patterns are not expressive enough.
RankingRelevance Tuning with BM25, TF-IDF, and RRF
Choose ranking strategies deliberately and combine lexical, field, feature, and scripted signals without losing control.
Lexical QueryingScriptQuery for Custom JavaScript Filters
Filter documents with a JavaScript function when built-in query classes do not express the rule cleanly.
RankingScriptScoreQuery for Custom JavaScript Scoring
Rescore matching documents with a JavaScript function that combines `_score` with your own business logic.
OverviewSearch Engine Techniques for Analytics UIs
How search-style filtering and aggregation patterns translate naturally into exploratory analytics interfaces.
IndexingSerialization, Hydration, and Shipping Indexes
Prebuild index state, ship JSON to the client, and rehydrate fast without reindexing in the browser.
Other FeaturesSimpleTextSearch for Plain JSON Documents
A beginner path that builds a usable index from plain objects and runs a good-enough default search.
GuidesSlicing and Dicing Open Data with Querylight TS
Use small open-data snapshots to prototype interactive analytics in the browser with Querylight TS.
DiscoveryStats Aggregation
Get count, min, max, sum, and average from a numeric or date field in one call.
DiscoverySum Aggregation
Add up all indexed numeric or date values in a field, optionally within a filtered subset.
Lexical QueryingTerm, Terms, Prefix, Exists, and Match Queries
Use exact term lookups, field existence checks, prefix lookup, or analyzed text matching.
DiscoveryTerms Aggregation and Significant Terms
Build term facets from the current result set and surface discriminative vocabulary.
OperationsTesting Patterns from the Repository
The test suite documents expected ranking, query, vector, and geo behavior.
OperationsTesting Search Behavior
Write tests around ranking, filtering, edge cases, and representative user queries instead of only API smoke tests.
RankingTF-IDF and BM25 Ranking
Choose between classic term weighting and Lucene-style BM25 scoring.
IndexingTrie-Backed Prefix Expansion
Autocomplete-style search is built from indexed terms.
GuidesUsing Querylight TS as a Local Analytics Engine
How to use Querylight TS filtering and aggregation primitives for browser-side analytics over plain JSON records.
DiscoveryValue Count Aggregation
Count how many numeric or date values are indexed, optionally within the current result set.
Other FeaturesVector Rescoring for Faster Hybrid Search
Rescore only the top lexical candidates with vectors when full vector retrieval would be too broad or too slow.
OverviewWhat Querylight TS Can Do Beyond Full-Text Search
Querylight TS can power more than lexical retrieval, including faceting, aggregations, semantic retrieval, geo filtering, and lightweight dashboards.
OverviewWhat Querylight TS Covers
A compact browser and Node.js search toolkit for structured, explainable retrieval.
OverviewWhy Local-First Data Exploration Helps API Prototyping
Explore raw API payloads locally before committing to a larger backend analytics architecture.
Lexical QueryingWildcardQuery for Term-Level Pattern Matching
Match indexed terms with `*` and `?` patterns without switching to full-text analysis.