jsdoc: Link between Task.allDateFields and AllTaskDateFields

ilandikov · Aug 18, 2024 · de4256a · de4256a
1 parent 10ed88d
commit de4256a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/DateTime/DateFieldTypes.ts b/src/DateTime/DateFieldTypes.ts
@@ -4,6 +4,9 @@ import type { Task } from '../Task/Task';
 export type HappensDate = keyof Pick<Task, 'startDate' | 'scheduledDate' | 'dueDate'>;
 
 // NEW_TASK_FIELD_EDIT_REQUIRED - if new field is a date field.
+/**
+ * See also {@link Task.allDateFields}
+ */
 export type AllTaskDateFields = keyof Pick<
  Task,
  'cancelledDate' | 'createdDate' | 'doneDate' | 'dueDate' | 'scheduledDate' | 'startDate' // alphabetical order, please.

diff --git a/src/Task/Task.ts b/src/Task/Task.ts
@@ -893,6 +893,9 @@ export class Task extends ListItem {
  return true;
  }
 
+ /**
+ * See also {@link AllTaskDateFields}
+ */
  public static allDateFields(): (keyof Task)[] {
  return [
  'createdDate' as keyof Task,