summaryrefslogtreecommitdiff
path: root/docs/interfaces
diff options
context:
space:
mode:
authortoasted-nutbread <toasted-nutbread@users.noreply.github.com>2021-06-26 11:57:09 -0400
committerGitHub <noreply@github.com>2021-06-26 11:57:09 -0400
commit6e0a367afcae07ae6f8274c7310950af613b4bf0 (patch)
tree4cc45dd6b2f3b53aeaf1c9eb95db774aabcad5b2 /docs/interfaces
parent5756885fa9340f087a168d40c8d0d10a3a8fe4d5 (diff)
Translator data format updates (#1754)
* Add {dictionaryIndex, dictionaryPriority} to definitions * Add score to definitions * Add id to definition * Use definition id instead of ids array * Remove ids array * Update docs * Update test data
Diffstat (limited to 'docs/interfaces')
-rw-r--r--docs/interfaces/dictionary-entry.ts20
1 files changed, 16 insertions, 4 deletions
diff --git a/docs/interfaces/dictionary-entry.ts b/docs/interfaces/dictionary-entry.ts
index da2a0151..d170f6df 100644
--- a/docs/interfaces/dictionary-entry.ts
+++ b/docs/interfaces/dictionary-entry.ts
@@ -192,10 +192,6 @@ namespace Translation {
*/
export interface TermDictionaryEntry extends DictionaryEntry {
/**
- * Database IDs for the term.
- */
- ids: number[];
- /**
* Whether or not any of the sources is a primary source. Primary sources are derived from the
* original search text, while non-primary sources originate from related terms.
*/
@@ -289,6 +285,22 @@ namespace Translation {
*/
dictionary: string;
/**
+ * The index of the dictionary in the original list of dictionaries used for the lookup.
+ */
+ dictionaryIndex: number;
+ /**
+ * The priority of the dictionary.
+ */
+ dictionaryPriority: number;
+ /**
+ * Database ID for the definition.
+ */
+ id: number[];
+ /**
+ * A score for the definition.
+ */
+ score: number;
+ /**
* A list of database sequence numbers for the term. A value of `-1` corresponds to no sequence.
* The list can have multiple values if multiple definitions with different sequences have been merged.
* The list should always have at least one item.