From e593aef5dd6fc2ed33c1e948ffc10ac6f832e9ce Mon Sep 17 00:00:00 2001 From: Matt Weber Date: Thu, 26 Dec 2013 16:10:39 -0800 Subject: [PATCH] Cleanup docs. --- dist/elastic.js | 137 +++++++++++++++++++--- dist/elastic.min.js | 2 +- docs/build.sh | 2 + docs/templates/elasticjs/publish.js | 48 +++++--- src/facet/DateHistogramFacet.js | 1 + src/facet/FilterFacet.js | 1 + src/facet/GeoDistanceFacet.js | 1 + src/facet/HistogramFacet.js | 1 + src/facet/QueryFacet.js | 1 + src/facet/RangeFacet.js | 1 + src/facet/StatisticalFacet.js | 1 + src/facet/TermStatsFacet.js | 1 + src/facet/TermsFacet.js | 1 + src/filter/AndFilter.js | 1 + src/filter/BoolFilter.js | 1 + src/filter/ExistsFilter.js | 1 + src/filter/GeoBboxFilter.js | 1 + src/filter/GeoDistanceFilter.js | 1 + src/filter/GeoDistanceRangeFilter.js | 1 + src/filter/GeoPolygonFilter.js | 1 + src/filter/GeoShapeFilter.js | 1 + src/filter/HasChildFilter.js | 1 + src/filter/HasParentFilter.js | 1 + src/filter/IdsFilter.js | 1 + src/filter/IndicesFilter.js | 1 + src/filter/LimitFilter.js | 1 + src/filter/MatchAllFilter.js | 1 + src/filter/MissingFilter.js | 1 + src/filter/NestedFilter.js | 1 + src/filter/NotFilter.js | 1 + src/filter/NumericRangeFilter.js | 1 + src/filter/OrFilter.js | 1 + src/filter/PrefixFilter.js | 1 + src/filter/QueryFilter.js | 1 + src/filter/RangeFilter.js | 1 + src/filter/RegexpFilter.js | 1 + src/filter/ScriptFilter.js | 1 + src/filter/TermFilter.js | 1 + src/filter/TermsFilter.js | 1 + src/filter/TypeFilter.js | 1 + src/query/BoolQuery.js | 1 + src/query/BoostingQuery.js | 1 + src/query/CommonTermsQuery.js | 1 + src/query/ConstantScoreQuery.js | 1 + src/query/CustomBoostFactorQuery.js | 1 + src/query/CustomFiltersScoreQuery.js | 1 + src/query/CustomScoreQuery.js | 1 + src/query/DisMaxQuery.js | 1 + src/query/FieldMaskingSpanQuery.js | 1 + src/query/FieldQuery.js | 1 + src/query/FilteredQuery.js | 1 + src/query/FuzzyLikeThisFieldQuery.js | 1 + src/query/FuzzyLikeThisQuery.js | 1 + src/query/FuzzyQuery.js | 1 + src/query/GeoShapeQuery.js | 1 + src/query/HasChildQuery.js | 1 + src/query/HasParentQuery.js | 1 + src/query/IdsQuery.js | 1 + src/query/IndicesQuery.js | 1 + src/query/MatchAllQuery.js | 1 + src/query/MatchQuery.js | 1 + src/query/MoreLikeThisFieldQuery.js | 1 + src/query/MoreLikeThisQuery.js | 1 + src/query/MultiMatchQuery.js | 1 + src/query/NestedQuery.js | 1 + src/query/PrefixQuery.js | 1 + src/query/QueryStringQuery.js | 1 + src/query/RangeQuery.js | 1 + src/query/RegexpQuery.js | 1 + src/query/SpanFirstQuery.js | 1 + src/query/SpanMultiTermQuery.js | 1 + src/query/SpanNearQuery.js | 1 + src/query/SpanNotQuery.js | 1 + src/query/SpanOrQuery.js | 1 + src/query/SpanTermQuery.js | 1 + src/query/TermQuery.js | 1 + src/query/TermsQuery.js | 1 + src/query/TopChildrenQuery.js | 1 + src/query/WildcardQuery.js | 1 + src/search/GeoPoint.js | 1 + src/search/Highlight.js | 1 + src/search/IndexedShape.js | 1 + src/search/Request.js | 1 + src/search/Rescore.js | 1 + src/search/ScriptField.js | 1 + src/search/Shape.js | 1 + src/search/Sort.js | 1 + src/search/suggest/CompletionSuggester.js | 11 +- src/search/suggest/DirectGenerator.js | 13 +- src/search/suggest/DirectSettingsMixin.js | 2 + src/search/suggest/PhraseSuggester.js | 10 +- src/search/suggest/SuggestContextMixin.js | 2 + src/search/suggest/SuggesterMixin.js | 2 + src/search/suggest/TermSuggester.js | 12 +- 94 files changed, 275 insertions(+), 49 deletions(-) diff --git a/dist/elastic.js b/dist/elastic.js index f4ff5e0..292dab9 100644 --- a/dist/elastic.js +++ b/dist/elastic.js @@ -1,4 +1,4 @@ -/*! elastic.js - v1.1.1 - 2013-12-21 +/*! elastic.js - v1.1.1 - 2013-12-26 * https://github.com/fullscale/elastic.js * Copyright (c) 2013 FullScale Labs, LLC; Licensed MIT */ @@ -237,6 +237,7 @@ @name ejs.DateHistogramFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode @@ -719,6 +720,7 @@ @name ejs.FilterFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode @@ -788,6 +790,7 @@ @name ejs.GeoDistanceFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode @@ -1077,6 +1080,7 @@ @name ejs.HistogramFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode @@ -1341,6 +1345,7 @@ @name ejs.QueryFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode @@ -1409,6 +1414,7 @@ @name ejs.RangeFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode @@ -1637,6 +1643,7 @@ @name ejs.StatisticalFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode @@ -1773,6 +1780,7 @@ @name ejs.TermStatsFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode @@ -1991,6 +1999,7 @@ Faceted Classification @name ejs.ExistsFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -2642,6 +2654,7 @@ the specified lon and lat coordinates. The format conforms with the GeoJSON specification.

@name ejs.GeoBboxFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -2778,6 +2791,7 @@ point of origin. The format conforms with the GeoJSON specification.

@name ejs.GeoDistanceFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -2960,6 +2974,7 @@ point of origin. The format conforms with the GeoJSON specification.

@name ejs.GeoDistanceRangeFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -3277,6 +3292,7 @@ for each document as a Geo Point type. The format conforms with the GeoJSON specification.

@name ejs.GeoPolygonFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -3392,6 +3408,7 @@ PrefixTree configuration as defined for the field.

@name ejs.GeoShapeFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -3539,6 +3556,7 @@ matching the query being returned.

@name ejs.HasChildFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -3661,6 +3679,7 @@ the query being returned.

@name ejs.HasParentFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -3768,6 +3787,7 @@ _uid field.

@name ejs.IdsFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -3861,6 +3881,7 @@ is executed on an index that does not match the listed indices.

@name ejs.IndicesFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -3978,6 +3999,7 @@

A limit filter limits the number of documents (per shard) to execute on.

@name ejs.LimitFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -4028,6 +4050,7 @@ in a given set of collections and/or types.

@name ejs.MatchAllFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -4047,6 +4070,7 @@

An missingFilter matches documents where the specified field contains no legitimate value.

@name ejs.MissingFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -4132,6 +4156,7 @@ parent doc (or parent nested mapping).

@name ejs.NestedFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -4264,6 +4289,7 @@ contained filter.

@name ejs.NotFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -4328,6 +4354,7 @@ filter should be used.

@name ejs.NumericRangeFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -4536,6 +4563,7 @@ A container filter that allows Boolean OR composition of filters. @name ejs.OrFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -4616,6 +4644,7 @@ to phrase query, except that it acts as a filter. Can be placed within queries that accept a filter.

@name ejs.PrefixFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -4692,6 +4721,7 @@ caching (since it needs to satisfy different queries).

@name ejs.QueryFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -4745,6 +4775,7 @@

Matches documents with fields that have terms within a certain range.

@name ejs.RangeFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -4930,6 +4961,7 @@ over index terms.

@name ejs.RegexpFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -5044,6 +5076,7 @@

A filter allowing to define scripts as filters

@name ejs.ScriptFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -5125,6 +5158,7 @@ terms that are not necessarily in a sequence.

@name ejs.TermFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -5198,6 +5232,7 @@ terms (not analyzed)

@name ejs.TermsFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -5429,6 +5464,7 @@

A Filter that filters results by a specified index type.

@name ejs.TypeFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey @@ -5476,6 +5512,7 @@ for documents containing the terms javascript and python.

@name ejs.BoolQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -5671,6 +5708,7 @@ score.

@name ejs.BoostingQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -5779,6 +5817,7 @@ across domains without specialized stopword files.

@name ejs.CommonTermsQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -6025,6 +6064,7 @@ queryNorm, but maintain the same relevance.

@name ejs.ConstantScoreQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -6123,6 +6163,7 @@ on specific queries gets normalized, while this query boost factor does not.

@name ejs.CustomBoostFactorQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -6196,6 +6237,7 @@ boosting / script is considerably simpler.

@name ejs.CustomFiltersScoreQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -6396,6 +6438,7 @@ doc (numeric ones) using script expression.

@name ejs.CustomScoreQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -6527,6 +6570,7 @@ subqueries. @name ejs.DisMaxQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -6618,6 +6662,7 @@ the real field used in the wrapped span query.

@name ejs.FieldMaskingSpanQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -6689,6 +6734,7 @@ of the queryString object. @name ejs.FieldQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -7155,6 +7201,7 @@ a new Query that is then used for the search.

@name ejs.FilteredQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -7326,6 +7373,7 @@ average IDF of the variants is used.

@name ejs.FuzzyLikeThisFieldQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -7524,6 +7572,7 @@ average IDF of the variants is used.

@name ejs.FuzzyLikeThisQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -7702,6 +7751,7 @@ of "2", the query will search for values between "10" and "14".

@name ejs.FuzzyQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -7908,6 +7958,7 @@ PrefixTree configuration as defined for the field.

@name ejs.GeoShapeQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -8069,6 +8120,7 @@ parent documents that have child docs matching the query being returned.

@name ejs.HasChildQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -8221,6 +8273,7 @@ child documents that have parent docs matching the query being returned.

@name ejs.HasParentQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -8353,6 +8406,7 @@ _uid field.

@name ejs.IdsQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -8444,6 +8498,7 @@ is executed on an index that does not match the listed indices.

@name ejs.IndicesQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -8559,6 +8614,7 @@ in a given set of collections and/or types.

@name ejs.MatchAllQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -8578,6 +8634,7 @@ MatchQuery type. @name ejs.MatchQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -8948,6 +9005,7 @@ except it runs against a single field.

@name ejs.MoreLikeThisFieldQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -9223,6 +9281,7 @@ running it against one or more fields.

@name ejs.MoreLikeThisQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -9497,6 +9556,7 @@ by using multiple match queries within a bool query. @name ejs.MultiMatchQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -9912,6 +9972,7 @@ nested mapping).

@name ejs.NestedQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -10035,6 +10096,7 @@ prefix (not analyzed). The prefix query maps to Lucene PrefixQuery.

@name ejs.PrefixQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -10225,6 +10287,7 @@ for more information.

@name ejs.QueryStringQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -10728,6 +10791,7 @@ NumericRangeQuery.

@name ejs.RangeQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -10926,6 +10990,7 @@ index terms.

@name ejs.RegexpQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -11103,6 +11168,7 @@ The span first query maps to Lucene SpanFirstQuery.

@name ejs.SpanFirstQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -11175,6 +11241,7 @@ Fuzzy, NumericRange, Prefix, Regex, Range, and Wildcard.

@name ejs.SpanMultiTermQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -11231,6 +11298,7 @@ distance from each other.

@name ejs.SpanNearQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -11361,6 +11429,7 @@ The span not query maps to Lucene SpanNotQuery.

@name ejs.SpanNotQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -11436,6 +11505,7 @@ underlying SpanQueries match. The span or query maps to Lucene SpanOrQuery.

@name ejs.SpanOrQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -11516,6 +11586,7 @@ spans containing a term. It's essentially a termQuery with positional information asscoaited.

@name ejs.SpanTermQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -11601,6 +11672,7 @@ often serve as the basis for more complex queries such as Boolean queries.

@name ejs.TermQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -11686,6 +11758,7 @@ in the should clauses.

@name ejs.TermsQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -11806,6 +11879,7 @@ specify max, sum or avg as the score type.

@name ejs.TopChildrenQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -11973,6 +12047,7 @@ maps to Lucene WildcardQuery.

@name ejs.WildcardQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON @@ -12107,6 +12182,7 @@

See http://www.elasticsearch.org/guide/reference/mapping/geo-point-type.html

@name ejs.GeoPoint + @ejs geo @desc

Defines a point

@@ -12270,6 +12346,7 @@

See http://www.elasticsearch.org/guide/reference/api/search/highlighting.html

@name ejs.Highlight + @ejs request @desc

Allows to highlight search results on one or more fields.

@@ -12706,6 +12783,7 @@ provide their coordinates each time.

@name ejs.IndexedShape + @ejs geo @desc

Defines a shape that already exists in an index/type.

@@ -12817,6 +12895,7 @@

The Request object provides methods generating an elasticsearch request body.

@name ejs.Request + @ejs request @desc

Provides methods for generating request bodies.

@@ -13287,6 +13366,7 @@

A method that allows to rescore queries with a typically more expensive.

@name ejs.Rescore + @ejs request @desc

Defines an operation that rescores a query with another query.

@@ -13457,6 +13537,7 @@ based on the calculation price * quantity.

@name ejs.ScriptField + @ejs request @desc

Computes dynamic document properties based on information from other fields.

@@ -13568,6 +13649,7 @@

See http://www.geojson.org/

@name ejs.Shape + @ejs geo @desc

Defines a shape

@@ -13685,6 +13767,7 @@

See http://www.elasticsearch.org/guide/reference/api/search/sort.html

@name ejs.Sort + @ejs request @desc

Defines a sort value

@@ -14121,11 +14204,20 @@ /** @class + @suggester

The completion suggester is a so-called prefix suggester. It does not do spell correction like the term or phrase suggesters but allows basic auto-complete functionality.

@name ejs.CompletionSuggester - + @ejs suggest + @borrows ejs.SuggesterMixin.text as text + @borrows ejs.SuggesterMixin._type as _type + @borrows ejs.SuggesterMixin.toJSON as toJSON + @borrows ejs.SuggestContextMixin.analyzer as analyzer + @borrows ejs.SuggestContextMixin.field as field + @borrows ejs.SuggestContextMixin.size as size + @borrows ejs.SuggestContextMixin.shardSize as shardSize + @since elasticsearch 0.90.4 @desc @@ -14284,12 +14376,7 @@ TermSuggester.

@name ejs.DirectGenerator - - @since elasticsearch 0.90 - - @desc -

A candidate generator that generates terms based on edit distance.

- + @ejs suggest @borrows ejs.DirectSettingsMixin.accuracy as accuracy @borrows ejs.DirectSettingsMixin.suggestMode as suggestMode @borrows ejs.DirectSettingsMixin.sort as sort @@ -14300,6 +14387,12 @@ @borrows ejs.DirectSettingsMixin.prefixLength as prefixLength @borrows ejs.DirectSettingsMixin.minWordLen as minWordLen @borrows ejs.DirectSettingsMixin.minDocFreq as minDocFreq + + @since elasticsearch 0.90 + + @desc +

A candidate generator that generates terms based on edit distance.

+ */ ejs.DirectGenerator = function () { @@ -14408,6 +14501,8 @@ used directly.

@name ejs.DirectSettingsMixin + + @param {String} settings The object to set the options on. */ ejs.DirectSettingsMixin = function (settings) { @@ -14625,7 +14720,15 @@ co-occurence and frequencies.

@name ejs.PhraseSuggester - + @ejs suggest + @borrows ejs.SuggesterMixin.text as text + @borrows ejs.SuggesterMixin._type as _type + @borrows ejs.SuggesterMixin.toJSON as toJSON + @borrows ejs.SuggestContextMixin.analyzer as analyzer + @borrows ejs.SuggestContextMixin.field as field + @borrows ejs.SuggestContextMixin.size as size + @borrows ejs.SuggestContextMixin.shardSize as shardSize + @since elasticsearch 0.90 @desc @@ -14911,6 +15014,8 @@ used directly.

@name ejs.SuggestContextMixin + + @param {String} settings The object to set the options on. */ ejs.SuggestContextMixin = function (settings) { @@ -14990,6 +15095,8 @@ This object should not be used directly.

@name ejs.SuggesterMixin + + @param {String} name The name of the suggester. */ ejs.SuggesterMixin = function (name) { @@ -15048,12 +15155,7 @@ PhraseSuggester.

@name ejs.TermSuggester - - @since elasticsearch 0.90 - - @desc -

A suggester that suggests terms based on edit distance.

- + @ejs suggest @borrows ejs.SuggesterMixin.text as text @borrows ejs.SuggesterMixin._type as _type @borrows ejs.SuggesterMixin.toJSON as toJSON @@ -15072,6 +15174,11 @@ @borrows ejs.SuggestContextMixin.size as size @borrows ejs.SuggestContextMixin.shardSize as shardSize + @since elasticsearch 0.90 + + @desc +

A suggester that suggests terms based on edit distance.

+ @param {String} name The name which be used to refer to this suggester. */ ejs.TermSuggester = function (name) { diff --git a/dist/elastic.min.js b/dist/elastic.min.js index 4fd874e..f6365e1 100644 --- a/dist/elastic.min.js +++ b/dist/elastic.min.js @@ -1,4 +1,4 @@ -/*! elastic.js - v1.1.1 - 2013-12-21 +/*! elastic.js - v1.1.1 - 2013-12-26 * https://github.com/fullscale/elastic.js * Copyright (c) 2013 FullScale Labs, LLC; Licensed MIT */ diff --git a/docs/build.sh b/docs/build.sh index d5b8848..ec56ca3 100755 --- a/docs/build.sh +++ b/docs/build.sh @@ -1,3 +1,5 @@ #!/bin/bash +grunt ./jsdoc -t elasticjs -d ../dist/docs ../dist/elastic.js +#../node_modules/.bin/jsdoc -t elasticjs -d ../dist/docs ../dist/elastic.js diff --git a/docs/templates/elasticjs/publish.js b/docs/templates/elasticjs/publish.js index 30014b3..6136444 100644 --- a/docs/templates/elasticjs/publish.js +++ b/docs/templates/elasticjs/publish.js @@ -201,6 +201,7 @@ var nav = '', seen = {}; + /* var moduleNames = find({kind: 'module'}); if (moduleNames.length) { nav = nav + '

Modules

'; } + */ // sorts an array of objects based on a property within that object var sort = function (prop, arr) { @@ -247,26 +249,34 @@ }); }; - var classNames = find({kind: 'class'}); - if (classNames.length) { - nav = nav + '

Modules

'; + var navWithTag = function (tag, header) { + var classNames = find({kind: 'class', tags:{has: {title: 'ejs', value: tag}}}); + if (classNames.length) { + nav = nav + '

' + header + '

'; + } } + navWithTag('request', 'Request'); + navWithTag('query', 'Queries'); + navWithTag('filter', 'Filters'); + navWithTag('facet', 'Facets'); + navWithTag('suggest', 'Suggesters'); + navWithTag('geo', 'Geo'); - + /* var mixinNames = find({kind: 'mixin'}); if (mixinNames.length) { nav = nav + '

Mixins

'; } - + var globalNames = find({kind: ['property', 'function'], 'memberof': {'isUndefined': true}}); - if (globalNames.length) { nav = nav + '

Global

'; } + */ for (var longname in helper.longnameToUrl) { var classes = find({kind: 'class', longname: longname}); diff --git a/src/facet/DateHistogramFacet.js b/src/facet/DateHistogramFacet.js index 16a3120..1a12e62 100644 --- a/src/facet/DateHistogramFacet.js +++ b/src/facet/DateHistogramFacet.js @@ -18,6 +18,7 @@ @name ejs.DateHistogramFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode diff --git a/src/facet/FilterFacet.js b/src/facet/FilterFacet.js index 63cd5d8..5550467 100644 --- a/src/facet/FilterFacet.js +++ b/src/facet/FilterFacet.js @@ -17,6 +17,7 @@ @name ejs.FilterFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode diff --git a/src/facet/GeoDistanceFacet.js b/src/facet/GeoDistanceFacet.js index 1e30818..5abf714 100644 --- a/src/facet/GeoDistanceFacet.js +++ b/src/facet/GeoDistanceFacet.js @@ -18,6 +18,7 @@ @name ejs.GeoDistanceFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode diff --git a/src/facet/HistogramFacet.js b/src/facet/HistogramFacet.js index f9d45e2..186d19d 100644 --- a/src/facet/HistogramFacet.js +++ b/src/facet/HistogramFacet.js @@ -18,6 +18,7 @@ @name ejs.HistogramFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode diff --git a/src/facet/QueryFacet.js b/src/facet/QueryFacet.js index a600292..7a4870b 100644 --- a/src/facet/QueryFacet.js +++ b/src/facet/QueryFacet.js @@ -17,6 +17,7 @@ @name ejs.QueryFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode diff --git a/src/facet/RangeFacet.js b/src/facet/RangeFacet.js index c54515e..9ea3b31 100644 --- a/src/facet/RangeFacet.js +++ b/src/facet/RangeFacet.js @@ -17,6 +17,7 @@ @name ejs.RangeFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode diff --git a/src/facet/StatisticalFacet.js b/src/facet/StatisticalFacet.js index 33e78de..d106144 100644 --- a/src/facet/StatisticalFacet.js +++ b/src/facet/StatisticalFacet.js @@ -17,6 +17,7 @@ @name ejs.StatisticalFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode diff --git a/src/facet/TermStatsFacet.js b/src/facet/TermStatsFacet.js index b2e6708..e4888d2 100644 --- a/src/facet/TermStatsFacet.js +++ b/src/facet/TermStatsFacet.js @@ -17,6 +17,7 @@ @name ejs.TermStatsFacet + @ejs facet @borrows ejs.FacetMixin.facetFilter as facetFilter @borrows ejs.FacetMixin.global as global @borrows ejs.FacetMixin.mode as mode diff --git a/src/facet/TermsFacet.js b/src/facet/TermsFacet.js index 8e105d9..95e421c 100644 --- a/src/facet/TermsFacet.js +++ b/src/facet/TermsFacet.js @@ -13,6 +13,7 @@ Faceted Classification @name ejs.ExistsFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/GeoBboxFilter.js b/src/filter/GeoBboxFilter.js index 3c000ce..97c66ce 100644 --- a/src/filter/GeoBboxFilter.js +++ b/src/filter/GeoBboxFilter.js @@ -4,6 +4,7 @@ the specified lon and lat coordinates. The format conforms with the GeoJSON specification.

@name ejs.GeoBboxFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/GeoDistanceFilter.js b/src/filter/GeoDistanceFilter.js index 5d9e16b..6a075ff 100644 --- a/src/filter/GeoDistanceFilter.js +++ b/src/filter/GeoDistanceFilter.js @@ -4,6 +4,7 @@ point of origin. The format conforms with the GeoJSON specification.

@name ejs.GeoDistanceFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/GeoDistanceRangeFilter.js b/src/filter/GeoDistanceRangeFilter.js index 31e77e7..be6a3ee 100644 --- a/src/filter/GeoDistanceRangeFilter.js +++ b/src/filter/GeoDistanceRangeFilter.js @@ -4,6 +4,7 @@ point of origin. The format conforms with the GeoJSON specification.

@name ejs.GeoDistanceRangeFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/GeoPolygonFilter.js b/src/filter/GeoPolygonFilter.js index 2e0325c..4ae00dd 100644 --- a/src/filter/GeoPolygonFilter.js +++ b/src/filter/GeoPolygonFilter.js @@ -4,6 +4,7 @@ for each document as a Geo Point type. The format conforms with the GeoJSON specification.

@name ejs.GeoPolygonFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/GeoShapeFilter.js b/src/filter/GeoShapeFilter.js index 5869ee8..757915d 100644 --- a/src/filter/GeoShapeFilter.js +++ b/src/filter/GeoShapeFilter.js @@ -10,6 +10,7 @@ PrefixTree configuration as defined for the field.

@name ejs.GeoShapeFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/HasChildFilter.js b/src/filter/HasChildFilter.js index 269381a..ebc67e4 100644 --- a/src/filter/HasChildFilter.js +++ b/src/filter/HasChildFilter.js @@ -4,6 +4,7 @@ matching the query being returned.

@name ejs.HasChildFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/HasParentFilter.js b/src/filter/HasParentFilter.js index b5a48a9..ef3308c 100644 --- a/src/filter/HasParentFilter.js +++ b/src/filter/HasParentFilter.js @@ -4,6 +4,7 @@ the query being returned.

@name ejs.HasParentFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/IdsFilter.js b/src/filter/IdsFilter.js index e0e1b40..86e1013 100644 --- a/src/filter/IdsFilter.js +++ b/src/filter/IdsFilter.js @@ -5,6 +5,7 @@ _uid field.

@name ejs.IdsFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/IndicesFilter.js b/src/filter/IndicesFilter.js index ecdb2b9..c172cca 100644 --- a/src/filter/IndicesFilter.js +++ b/src/filter/IndicesFilter.js @@ -6,6 +6,7 @@ is executed on an index that does not match the listed indices.

@name ejs.IndicesFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/LimitFilter.js b/src/filter/LimitFilter.js index 61be116..fe51039 100644 --- a/src/filter/LimitFilter.js +++ b/src/filter/LimitFilter.js @@ -3,6 +3,7 @@

A limit filter limits the number of documents (per shard) to execute on.

@name ejs.LimitFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/MatchAllFilter.js b/src/filter/MatchAllFilter.js index 3495fe4..eea70ef 100644 --- a/src/filter/MatchAllFilter.js +++ b/src/filter/MatchAllFilter.js @@ -4,6 +4,7 @@ in a given set of collections and/or types.

@name ejs.MatchAllFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/MissingFilter.js b/src/filter/MissingFilter.js index f1bb032..623bdbc 100644 --- a/src/filter/MissingFilter.js +++ b/src/filter/MissingFilter.js @@ -3,6 +3,7 @@

An missingFilter matches documents where the specified field contains no legitimate value.

@name ejs.MissingFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/NestedFilter.js b/src/filter/NestedFilter.js index b7393e8..c8f7126 100644 --- a/src/filter/NestedFilter.js +++ b/src/filter/NestedFilter.js @@ -10,6 +10,7 @@ parent doc (or parent nested mapping).

@name ejs.NestedFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/NotFilter.js b/src/filter/NotFilter.js index b046f63..c705846 100644 --- a/src/filter/NotFilter.js +++ b/src/filter/NotFilter.js @@ -4,6 +4,7 @@ contained filter.

@name ejs.NotFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/NumericRangeFilter.js b/src/filter/NumericRangeFilter.js index 6502bd6..7fc3e5e 100644 --- a/src/filter/NumericRangeFilter.js +++ b/src/filter/NumericRangeFilter.js @@ -14,6 +14,7 @@ filter should be used.

@name ejs.NumericRangeFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/OrFilter.js b/src/filter/OrFilter.js index f6cd6f1..2fafc3f 100644 --- a/src/filter/OrFilter.js +++ b/src/filter/OrFilter.js @@ -3,6 +3,7 @@ A container filter that allows Boolean OR composition of filters. @name ejs.OrFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/PrefixFilter.js b/src/filter/PrefixFilter.js index 047a769..9586fdb 100644 --- a/src/filter/PrefixFilter.js +++ b/src/filter/PrefixFilter.js @@ -4,6 +4,7 @@ to phrase query, except that it acts as a filter. Can be placed within queries that accept a filter.

@name ejs.PrefixFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/QueryFilter.js b/src/filter/QueryFilter.js index 57dc39b..2d66cb2 100644 --- a/src/filter/QueryFilter.js +++ b/src/filter/QueryFilter.js @@ -11,6 +11,7 @@ caching (since it needs to satisfy different queries).

@name ejs.QueryFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/RangeFilter.js b/src/filter/RangeFilter.js index bd5352f..1254daf 100644 --- a/src/filter/RangeFilter.js +++ b/src/filter/RangeFilter.js @@ -3,6 +3,7 @@

Matches documents with fields that have terms within a certain range.

@name ejs.RangeFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/RegexpFilter.js b/src/filter/RegexpFilter.js index 76c2f45..78267c1 100644 --- a/src/filter/RegexpFilter.js +++ b/src/filter/RegexpFilter.js @@ -5,6 +5,7 @@ over index terms.

@name ejs.RegexpFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/ScriptFilter.js b/src/filter/ScriptFilter.js index ca139ab..758fe06 100644 --- a/src/filter/ScriptFilter.js +++ b/src/filter/ScriptFilter.js @@ -3,6 +3,7 @@

A filter allowing to define scripts as filters

@name ejs.ScriptFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/TermFilter.js b/src/filter/TermFilter.js index 605b44e..a45e776 100644 --- a/src/filter/TermFilter.js +++ b/src/filter/TermFilter.js @@ -5,6 +5,7 @@ terms that are not necessarily in a sequence.

@name ejs.TermFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/TermsFilter.js b/src/filter/TermsFilter.js index a5a04e8..7ab8dd4 100644 --- a/src/filter/TermsFilter.js +++ b/src/filter/TermsFilter.js @@ -4,6 +4,7 @@ terms (not analyzed)

@name ejs.TermsFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/filter/TypeFilter.js b/src/filter/TypeFilter.js index cff09bb..63237f8 100644 --- a/src/filter/TypeFilter.js +++ b/src/filter/TypeFilter.js @@ -3,6 +3,7 @@

A Filter that filters results by a specified index type.

@name ejs.TypeFilter + @ejs filter @borrows ejs.FilterMixin.name as name @borrows ejs.FilterMixin.cache as cache @borrows ejs.FilterMixin.cacheKey as cacheKey diff --git a/src/query/BoolQuery.js b/src/query/BoolQuery.js index 53b4d85..fd8b331 100644 --- a/src/query/BoolQuery.js +++ b/src/query/BoolQuery.js @@ -5,6 +5,7 @@ for documents containing the terms javascript and python.

@name ejs.BoolQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/BoostingQuery.js b/src/query/BoostingQuery.js index 12a84e6..8650e3f 100644 --- a/src/query/BoostingQuery.js +++ b/src/query/BoostingQuery.js @@ -6,6 +6,7 @@ score.

@name ejs.BoostingQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/CommonTermsQuery.js b/src/query/CommonTermsQuery.js index 5967d23..b96e856 100644 --- a/src/query/CommonTermsQuery.js +++ b/src/query/CommonTermsQuery.js @@ -14,6 +14,7 @@ across domains without specialized stopword files.

@name ejs.CommonTermsQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/ConstantScoreQuery.js b/src/query/ConstantScoreQuery.js index 4d034bf..8877af4 100644 --- a/src/query/ConstantScoreQuery.js +++ b/src/query/ConstantScoreQuery.js @@ -12,6 +12,7 @@ queryNorm, but maintain the same relevance.

@name ejs.ConstantScoreQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/CustomBoostFactorQuery.js b/src/query/CustomBoostFactorQuery.js index 2a2b363..5866efe 100644 --- a/src/query/CustomBoostFactorQuery.js +++ b/src/query/CustomBoostFactorQuery.js @@ -5,6 +5,7 @@ on specific queries gets normalized, while this query boost factor does not.

@name ejs.CustomBoostFactorQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/CustomFiltersScoreQuery.js b/src/query/CustomFiltersScoreQuery.js index 9d9c824..f381758 100644 --- a/src/query/CustomFiltersScoreQuery.js +++ b/src/query/CustomFiltersScoreQuery.js @@ -9,6 +9,7 @@ boosting / script is considerably simpler.

@name ejs.CustomFiltersScoreQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/CustomScoreQuery.js b/src/query/CustomScoreQuery.js index 74cfbf2..27f6ebe 100644 --- a/src/query/CustomScoreQuery.js +++ b/src/query/CustomScoreQuery.js @@ -5,6 +5,7 @@ doc (numeric ones) using script expression.

@name ejs.CustomScoreQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/DisMaxQuery.js b/src/query/DisMaxQuery.js index 30ff982..b185fec 100644 --- a/src/query/DisMaxQuery.js +++ b/src/query/DisMaxQuery.js @@ -6,6 +6,7 @@ subqueries. @name ejs.DisMaxQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/FieldMaskingSpanQuery.js b/src/query/FieldMaskingSpanQuery.js index 88fd5f7..3b21daa 100644 --- a/src/query/FieldMaskingSpanQuery.js +++ b/src/query/FieldMaskingSpanQuery.js @@ -7,6 +7,7 @@ the real field used in the wrapped span query.

@name ejs.FieldMaskingSpanQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/FieldQuery.js b/src/query/FieldQuery.js index 03e2986..5f1acf4 100644 --- a/src/query/FieldQuery.js +++ b/src/query/FieldQuery.js @@ -4,6 +4,7 @@ of the queryString object. @name ejs.FieldQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/FilteredQuery.js b/src/query/FilteredQuery.js index 3662559..eb3e8db 100644 --- a/src/query/FilteredQuery.js +++ b/src/query/FilteredQuery.js @@ -7,6 +7,7 @@ a new Query that is then used for the search.

@name ejs.FilteredQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/FuzzyLikeThisFieldQuery.js b/src/query/FuzzyLikeThisFieldQuery.js index d7e3022..a44b1d3 100644 --- a/src/query/FuzzyLikeThisFieldQuery.js +++ b/src/query/FuzzyLikeThisFieldQuery.js @@ -23,6 +23,7 @@ average IDF of the variants is used.

@name ejs.FuzzyLikeThisFieldQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/FuzzyLikeThisQuery.js b/src/query/FuzzyLikeThisQuery.js index 83237c0..4602b68 100644 --- a/src/query/FuzzyLikeThisQuery.js +++ b/src/query/FuzzyLikeThisQuery.js @@ -20,6 +20,7 @@ average IDF of the variants is used.

@name ejs.FuzzyLikeThisQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/FuzzyQuery.js b/src/query/FuzzyQuery.js index f9438da..a4744bb 100644 --- a/src/query/FuzzyQuery.js +++ b/src/query/FuzzyQuery.js @@ -10,6 +10,7 @@ of "2", the query will search for values between "10" and "14".

@name ejs.FuzzyQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/GeoShapeQuery.js b/src/query/GeoShapeQuery.js index 994826b..4ac8147 100644 --- a/src/query/GeoShapeQuery.js +++ b/src/query/GeoShapeQuery.js @@ -10,6 +10,7 @@ PrefixTree configuration as defined for the field.

@name ejs.GeoShapeQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/HasChildQuery.js b/src/query/HasChildQuery.js index 3cd2261..6fb92d5 100644 --- a/src/query/HasChildQuery.js +++ b/src/query/HasChildQuery.js @@ -5,6 +5,7 @@ parent documents that have child docs matching the query being returned.

@name ejs.HasChildQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/HasParentQuery.js b/src/query/HasParentQuery.js index 0be89d8..1fc62ca 100644 --- a/src/query/HasParentQuery.js +++ b/src/query/HasParentQuery.js @@ -5,6 +5,7 @@ child documents that have parent docs matching the query being returned.

@name ejs.HasParentQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/IdsQuery.js b/src/query/IdsQuery.js index 7ff386d..ca271dc 100644 --- a/src/query/IdsQuery.js +++ b/src/query/IdsQuery.js @@ -5,6 +5,7 @@ _uid field.

@name ejs.IdsQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/IndicesQuery.js b/src/query/IndicesQuery.js index 92bf6d0..4531c3a 100644 --- a/src/query/IndicesQuery.js +++ b/src/query/IndicesQuery.js @@ -6,6 +6,7 @@ is executed on an index that does not match the listed indices.

@name ejs.IndicesQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/MatchAllQuery.js b/src/query/MatchAllQuery.js index d275a4f..a66c0d8 100644 --- a/src/query/MatchAllQuery.js +++ b/src/query/MatchAllQuery.js @@ -4,6 +4,7 @@ in a given set of collections and/or types.

@name ejs.MatchAllQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/MatchQuery.js b/src/query/MatchQuery.js index 285fcdc..8ec85ff 100644 --- a/src/query/MatchQuery.js +++ b/src/query/MatchQuery.js @@ -5,6 +5,7 @@ MatchQuery type. @name ejs.MatchQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/MoreLikeThisFieldQuery.js b/src/query/MoreLikeThisFieldQuery.js index d9570a6..336cd88 100644 --- a/src/query/MoreLikeThisFieldQuery.js +++ b/src/query/MoreLikeThisFieldQuery.js @@ -4,6 +4,7 @@ except it runs against a single field.

@name ejs.MoreLikeThisFieldQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/MoreLikeThisQuery.js b/src/query/MoreLikeThisQuery.js index 4513ef3..2635143 100644 --- a/src/query/MoreLikeThisQuery.js +++ b/src/query/MoreLikeThisQuery.js @@ -4,6 +4,7 @@ running it against one or more fields.

@name ejs.MoreLikeThisQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/MultiMatchQuery.js b/src/query/MultiMatchQuery.js index c5ce578..b4b7b89 100644 --- a/src/query/MultiMatchQuery.js +++ b/src/query/MultiMatchQuery.js @@ -7,6 +7,7 @@ by using multiple match queries within a bool query. @name ejs.MultiMatchQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/NestedQuery.js b/src/query/NestedQuery.js index e992038..38c0243 100644 --- a/src/query/NestedQuery.js +++ b/src/query/NestedQuery.js @@ -9,6 +9,7 @@ nested mapping).

@name ejs.NestedQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/PrefixQuery.js b/src/query/PrefixQuery.js index 5935275..e27dc02 100644 --- a/src/query/PrefixQuery.js +++ b/src/query/PrefixQuery.js @@ -4,6 +4,7 @@ prefix (not analyzed). The prefix query maps to Lucene PrefixQuery.

@name ejs.PrefixQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/QueryStringQuery.js b/src/query/QueryStringQuery.js index 9d6128c..14fdd8a 100644 --- a/src/query/QueryStringQuery.js +++ b/src/query/QueryStringQuery.js @@ -8,6 +8,7 @@ for more information.

@name ejs.QueryStringQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/RangeQuery.js b/src/query/RangeQuery.js index e8c5065..b6ecac5 100644 --- a/src/query/RangeQuery.js +++ b/src/query/RangeQuery.js @@ -6,6 +6,7 @@ NumericRangeQuery.

@name ejs.RangeQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/RegexpQuery.js b/src/query/RegexpQuery.js index 2c3baa6..dddc400 100644 --- a/src/query/RegexpQuery.js +++ b/src/query/RegexpQuery.js @@ -5,6 +5,7 @@ index terms.

@name ejs.RegexpQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/SpanFirstQuery.js b/src/query/SpanFirstQuery.js index e824409..197336d 100644 --- a/src/query/SpanFirstQuery.js +++ b/src/query/SpanFirstQuery.js @@ -5,6 +5,7 @@ The span first query maps to Lucene SpanFirstQuery.

@name ejs.SpanFirstQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/SpanMultiTermQuery.js b/src/query/SpanMultiTermQuery.js index e7c92ce..2da9f50 100644 --- a/src/query/SpanMultiTermQuery.js +++ b/src/query/SpanMultiTermQuery.js @@ -5,6 +5,7 @@ Fuzzy, NumericRange, Prefix, Regex, Range, and Wildcard.

@name ejs.SpanMultiTermQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/SpanNearQuery.js b/src/query/SpanNearQuery.js index a3d3f49..a969e20 100644 --- a/src/query/SpanNearQuery.js +++ b/src/query/SpanNearQuery.js @@ -4,6 +4,7 @@ distance from each other.

@name ejs.SpanNearQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/SpanNotQuery.js b/src/query/SpanNotQuery.js index 2ec0b1a..c24f9e2 100644 --- a/src/query/SpanNotQuery.js +++ b/src/query/SpanNotQuery.js @@ -4,6 +4,7 @@ The span not query maps to Lucene SpanNotQuery.

@name ejs.SpanNotQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/SpanOrQuery.js b/src/query/SpanOrQuery.js index 4d83bd8..f243859 100644 --- a/src/query/SpanOrQuery.js +++ b/src/query/SpanOrQuery.js @@ -4,6 +4,7 @@ underlying SpanQueries match. The span or query maps to Lucene SpanOrQuery.

@name ejs.SpanOrQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/SpanTermQuery.js b/src/query/SpanTermQuery.js index c2df139..d4e28d4 100644 --- a/src/query/SpanTermQuery.js +++ b/src/query/SpanTermQuery.js @@ -5,6 +5,7 @@ spans containing a term. It's essentially a termQuery with positional information asscoaited.

@name ejs.SpanTermQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/TermQuery.js b/src/query/TermQuery.js index 36cade7..c5749f6 100644 --- a/src/query/TermQuery.js +++ b/src/query/TermQuery.js @@ -6,6 +6,7 @@ often serve as the basis for more complex queries such as Boolean queries.

@name ejs.TermQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/TermsQuery.js b/src/query/TermsQuery.js index cbdc119..7af951b 100644 --- a/src/query/TermsQuery.js +++ b/src/query/TermsQuery.js @@ -5,6 +5,7 @@ in the should clauses.

@name ejs.TermsQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/TopChildrenQuery.js b/src/query/TopChildrenQuery.js index 51cbc1c..91fcd8c 100644 --- a/src/query/TopChildrenQuery.js +++ b/src/query/TopChildrenQuery.js @@ -9,6 +9,7 @@ specify max, sum or avg as the score type.

@name ejs.TopChildrenQuery + @ejs query @borrows ejs.QueryMixin.boost as boost @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/query/WildcardQuery.js b/src/query/WildcardQuery.js index 5af3857..ace780c 100644 --- a/src/query/WildcardQuery.js +++ b/src/query/WildcardQuery.js @@ -9,6 +9,7 @@ maps to Lucene WildcardQuery.

@name ejs.WildcardQuery + @ejs query @borrows ejs.QueryMixin._type as _type @borrows ejs.QueryMixin.toJSON as toJSON diff --git a/src/search/GeoPoint.js b/src/search/GeoPoint.js index 7d58806..e8c5be1 100644 --- a/src/search/GeoPoint.js +++ b/src/search/GeoPoint.js @@ -6,6 +6,7 @@

See http://www.elasticsearch.org/guide/reference/mapping/geo-point-type.html

@name ejs.GeoPoint + @ejs geo @desc

Defines a point

diff --git a/src/search/Highlight.js b/src/search/Highlight.js index bd9953d..e6b4c60 100644 --- a/src/search/Highlight.js +++ b/src/search/Highlight.js @@ -15,6 +15,7 @@

See http://www.elasticsearch.org/guide/reference/api/search/highlighting.html

@name ejs.Highlight + @ejs request @desc

Allows to highlight search results on one or more fields.

diff --git a/src/search/IndexedShape.js b/src/search/IndexedShape.js index 494375f..403a40f 100644 --- a/src/search/IndexedShape.js +++ b/src/search/IndexedShape.js @@ -7,6 +7,7 @@ provide their coordinates each time.

@name ejs.IndexedShape + @ejs geo @desc

Defines a shape that already exists in an index/type.

diff --git a/src/search/Request.js b/src/search/Request.js index edb76e4..2836368 100644 --- a/src/search/Request.js +++ b/src/search/Request.js @@ -3,6 +3,7 @@

The Request object provides methods generating an elasticsearch request body.

@name ejs.Request + @ejs request @desc

Provides methods for generating request bodies.

diff --git a/src/search/Rescore.js b/src/search/Rescore.js index 0d813be..56fb3f9 100644 --- a/src/search/Rescore.js +++ b/src/search/Rescore.js @@ -3,6 +3,7 @@

A method that allows to rescore queries with a typically more expensive.

@name ejs.Rescore + @ejs request @desc

Defines an operation that rescores a query with another query.

diff --git a/src/search/ScriptField.js b/src/search/ScriptField.js index 76270a0..becee25 100644 --- a/src/search/ScriptField.js +++ b/src/search/ScriptField.js @@ -7,6 +7,7 @@ based on the calculation price * quantity.

@name ejs.ScriptField + @ejs request @desc

Computes dynamic document properties based on information from other fields.

diff --git a/src/search/Shape.js b/src/search/Shape.js index 830925d..8ed9af1 100644 --- a/src/search/Shape.js +++ b/src/search/Shape.js @@ -6,6 +6,7 @@

See http://www.geojson.org/

@name ejs.Shape + @ejs geo @desc

Defines a shape

diff --git a/src/search/Sort.js b/src/search/Sort.js index 677008e..a206108 100644 --- a/src/search/Sort.js +++ b/src/search/Sort.js @@ -6,6 +6,7 @@

See http://www.elasticsearch.org/guide/reference/api/search/sort.html

@name ejs.Sort + @ejs request @desc

Defines a sort value

diff --git a/src/search/suggest/CompletionSuggester.js b/src/search/suggest/CompletionSuggester.js index 455265b..74fea7b 100644 --- a/src/search/suggest/CompletionSuggester.js +++ b/src/search/suggest/CompletionSuggester.js @@ -1,10 +1,19 @@ /** @class + @suggester

The completion suggester is a so-called prefix suggester. It does not do spell correction like the term or phrase suggesters but allows basic auto-complete functionality.

@name ejs.CompletionSuggester - + @ejs suggest + @borrows ejs.SuggesterMixin.text as text + @borrows ejs.SuggesterMixin._type as _type + @borrows ejs.SuggesterMixin.toJSON as toJSON + @borrows ejs.SuggestContextMixin.analyzer as analyzer + @borrows ejs.SuggestContextMixin.field as field + @borrows ejs.SuggestContextMixin.size as size + @borrows ejs.SuggestContextMixin.shardSize as shardSize + @since elasticsearch 0.90.4 @desc diff --git a/src/search/suggest/DirectGenerator.js b/src/search/suggest/DirectGenerator.js index 17f37cb..f00d5e9 100644 --- a/src/search/suggest/DirectGenerator.js +++ b/src/search/suggest/DirectGenerator.js @@ -5,12 +5,7 @@ TermSuggester.

@name ejs.DirectGenerator - - @since elasticsearch 0.90 - - @desc -

A candidate generator that generates terms based on edit distance.

- + @ejs suggest @borrows ejs.DirectSettingsMixin.accuracy as accuracy @borrows ejs.DirectSettingsMixin.suggestMode as suggestMode @borrows ejs.DirectSettingsMixin.sort as sort @@ -21,6 +16,12 @@ @borrows ejs.DirectSettingsMixin.prefixLength as prefixLength @borrows ejs.DirectSettingsMixin.minWordLen as minWordLen @borrows ejs.DirectSettingsMixin.minDocFreq as minDocFreq + + @since elasticsearch 0.90 + + @desc +

A candidate generator that generates terms based on edit distance.

+ */ ejs.DirectGenerator = function () { diff --git a/src/search/suggest/DirectSettingsMixin.js b/src/search/suggest/DirectSettingsMixin.js index 5b957cb..89778c1 100644 --- a/src/search/suggest/DirectSettingsMixin.js +++ b/src/search/suggest/DirectSettingsMixin.js @@ -5,6 +5,8 @@ used directly.

@name ejs.DirectSettingsMixin + + @param {String} settings The object to set the options on. */ ejs.DirectSettingsMixin = function (settings) { diff --git a/src/search/suggest/PhraseSuggester.js b/src/search/suggest/PhraseSuggester.js index a8e96b4..cb1f58c 100644 --- a/src/search/suggest/PhraseSuggester.js +++ b/src/search/suggest/PhraseSuggester.js @@ -7,7 +7,15 @@ co-occurence and frequencies.

@name ejs.PhraseSuggester - + @ejs suggest + @borrows ejs.SuggesterMixin.text as text + @borrows ejs.SuggesterMixin._type as _type + @borrows ejs.SuggesterMixin.toJSON as toJSON + @borrows ejs.SuggestContextMixin.analyzer as analyzer + @borrows ejs.SuggestContextMixin.field as field + @borrows ejs.SuggestContextMixin.size as size + @borrows ejs.SuggestContextMixin.shardSize as shardSize + @since elasticsearch 0.90 @desc diff --git a/src/search/suggest/SuggestContextMixin.js b/src/search/suggest/SuggestContextMixin.js index 080f14a..fbac544 100644 --- a/src/search/suggest/SuggestContextMixin.js +++ b/src/search/suggest/SuggestContextMixin.js @@ -5,6 +5,8 @@ used directly.

@name ejs.SuggestContextMixin + + @param {String} settings The object to set the options on. */ ejs.SuggestContextMixin = function (settings) { diff --git a/src/search/suggest/SuggesterMixin.js b/src/search/suggest/SuggesterMixin.js index 4d6a45a..2fd120b 100644 --- a/src/search/suggest/SuggesterMixin.js +++ b/src/search/suggest/SuggesterMixin.js @@ -4,6 +4,8 @@ This object should not be used directly.

@name ejs.SuggesterMixin + + @param {String} name The name of the suggester. */ ejs.SuggesterMixin = function (name) { diff --git a/src/search/suggest/TermSuggester.js b/src/search/suggest/TermSuggester.js index 2658220..18b97a3 100644 --- a/src/search/suggest/TermSuggester.js +++ b/src/search/suggest/TermSuggester.js @@ -7,12 +7,7 @@ PhraseSuggester.

@name ejs.TermSuggester - - @since elasticsearch 0.90 - - @desc -

A suggester that suggests terms based on edit distance.

- + @ejs suggest @borrows ejs.SuggesterMixin.text as text @borrows ejs.SuggesterMixin._type as _type @borrows ejs.SuggesterMixin.toJSON as toJSON @@ -31,6 +26,11 @@ @borrows ejs.SuggestContextMixin.size as size @borrows ejs.SuggestContextMixin.shardSize as shardSize + @since elasticsearch 0.90 + + @desc +

A suggester that suggests terms based on edit distance.

+ @param {String} name The name which be used to refer to this suggester. */ ejs.TermSuggester = function (name) {