Improve types in sidebar/helpers/view-filter.js

Author: robertknight

src/sidebar/helpers/view-filter.js

@@ -9,6 +9,7 @@
 
 /**
  * @typedef {import('../../types/api').Annotation} Annotation
+ * @typedef {import('../util/search-filter').Facet} Facet
  */
 
 import { quote } from './annotation-metadata';
@@ -26,6 +27,7 @@ import * as unicodeUtils from '../util/unicode';
  * @prop {(term: any, value: any) => boolean} match
  */
 
+/** @param {Annotation} ann */
 function displayName(ann) {
   if (!ann.user_info) {
     return '';
@@ -35,6 +37,9 @@ function displayName(ann) {
 
 /**
  * Normalize a field value or query term for comparison.
+ *
+ * @template {string|number} T
+ * @param {T} val
  */
 function normalize(val) {
   if (typeof val !== 'string') {
@@ -53,7 +58,7 @@ function normalize(val) {
 class TermFilter {
   /**
    * @param {string} field - Name of field to match
-   * @param {string} term - Query term
+   * @param {string|number} term - Query term
    * @param {Checker} checker - Functions for extracting term values from
    *   an annotation and checking whether they match a query term.
    */
@@ -63,6 +68,11 @@ class TermFilter {
     this.checker = checker;
   }
 
+  /**
+   * Return true if an annotation matches this filter.
+   *
+   * @param {Annotation} ann
+   */
   matches(ann) {
     const checker = this.checker;
     if (checker.autofalse && checker.autofalse(ann)) {
@@ -94,6 +104,11 @@ class BinaryOpFilter {
     this.filters = filters;
   }
 
+  /**
+   * Return true if an annotation matches this filter.
+   *
+   * @param {Annotation} ann
+   */
   matches(ann) {
     if (this.operator === 'and') {
       return this.filters.every(filter => filter.matches(ann));
@@ -154,8 +169,7 @@ const fieldMatchers = {
  * Filters a set of annotations.
  *
  * @param {Annotation[]} annotations
- * @param {object} filters - Faceted filter generated by
- * `generateFacetedFilter`.
+ * @param {Record<string, Facet>} filters - Faceted filter generated by `generateFacetedFilter`
  * @return {string[]} IDs of matching annotations.
  */
 export function filterAnnotations(annotations, filters) {