HoshinoKoji/jsPsych
1
0
Fork 0
mirror of https://github.com/jspsych/jsPsych.git synced 2025-05-10 11:10:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add docstring in JsPsych.ts for getCitations()

Browse Source
This commit is contained in:
Cherrie Chang 2024-12-18 16:50:24 -05:00
parent 909ac917b0
commit ca6c4eb63b
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
packages/jspsych/src/JsPsych.ts
View File

@ -261,6 +261,14 @@ export class JsPsych {
return this.timeline?.description.timeline; 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( getCitations(
plugins: Array<Class<JsPsychPlugin<any>> | Class<JsPsychExtension>> = [], plugins: Array<Class<JsPsychPlugin<any>> | Class<JsPsychExtension>> = [],
format: "apa" | "bibtex" = "apa" format: "apa" | "bibtex" = "apa"