add docstring in JsPsych.ts for getCitations()

jspsych · Dec 18, 2024 · ca6c4eb · ca6c4eb
1 parent 909ac91
commit ca6c4eb
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/jspsych/src/JsPsych.ts b/packages/jspsych/src/JsPsych.ts
@@ -261,6 +261,14 @@ export class JsPsych {
     return this.timeline?.description.timeline;
   }
 
+  /**
+   * Prints out a string containing citations for the jsPsych library and all input plugins/extensions in the specified format.
+   * If called without input, prints citation for jsPsych library.
+   *
+   * @param plugins The plugins/extensions to generate citations for. Always prints the citation for the jsPsych library at the top.
+   * @param format The desired output citation format. Currently supports "apa" and "bibtex".
+   * @returns String containing citations separated with newline character.
+   */
   getCitations(
     plugins: Array<Class<JsPsychPlugin<any>> | Class<JsPsychExtension>> = [],
     format: "apa" | "bibtex" = "apa"