summaryrefslogtreecommitdiff
path: root/docs/interfaces
diff options
context:
space:
mode:
authortoasted-nutbread <toasted-nutbread@users.noreply.github.com>2021-12-17 16:44:14 -0500
committerGitHub <noreply@github.com>2021-12-17 16:44:14 -0500
commit8e548a17eba180b5773a9900de3f3cb3a92ec6ff (patch)
treea0aa76481432fd5c510c3769ccadade86c7f15fa /docs/interfaces
parent19ab9df6e4110ef7d5927c95993141a1f8960c53 (diff)
Dictionary database term source info (#2039)
* Update DictionaryDatabase._findMultiBulk's createResult callback signature * Simplify _splitField use * Update sequence * Expose new fields 'matchType' and 'matchSource' as part of term data * Expose matchType and matchSource as part of TermSource * Update sourceTermExactMatchCount calculation * Update test data * Expose matchType and matchSource info in HTML attributes * Add primaryMatchTypes attribute
Diffstat (limited to 'docs/interfaces')
-rw-r--r--docs/interfaces/dictionary-entry.ts10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/interfaces/dictionary-entry.ts b/docs/interfaces/dictionary-entry.ts
index 2609a42a..16bc5eca 100644
--- a/docs/interfaces/dictionary-entry.ts
+++ b/docs/interfaces/dictionary-entry.ts
@@ -436,6 +436,16 @@ namespace Translation {
*/
deinflectedText: string;
/**
+ * How the deinflected text matches the value from the database.
+ * Value can be one of: 'exact', 'prefix', 'suffix'
+ */
+ matchType: string;
+ /**
+ * Which field was used to match the database entry.
+ * Value can be one of: 'term', 'reading', 'sequence'
+ */
+ matchSource: string;
+ /**
* Whether or not this source is a primary source. Primary sources are derived from the
* original search text, while non-primary sources originate from related terms.
*/