@jspsych/new-extension/templates/extension-template-js/src/index.js

CLI tool to create new jsPsych extensions

var _globalName_ = (function (jspsych) {
  "use strict";

  /**
   * **{packageName}**
   *
   * {description}
   *
   * @author {author}
   * @see {@link {documentationUrl}}
   */
  class ExtensionNameExtension {
    constructor(jsPsych) {
      this.jsPsych = jsPsych;
    }

    initialize(params) {
      return new Promise((resolve, reject) => {
        resolve();
      });
    }

    on_start(params) {}

    on_load(params) {}

    on_finish(params) {
      return {
        data1: 99, // Make sure this type and name matches the information for data1 in the data object contained within the info const.
        data2: "hello world!", // Make sure this type and name matches the information for data2 in the data object contained within the info const.
      };
    }
  }

  ExtensionNameExtension.info = {
    name: "{packageName}",
    version: "0.0.1", // When working in a Javascript environment with no build, you will need to manually put set the version information. This is used for metadata purposes and publishing.
    data: {
      /** Provide a clear description of the data1 that could be used as documentation. We will eventually use these comments to automatically build documentation and produce metadata. */
      data1: {
        type: ParameterType.INT,
      },
      /** Provide a clear description of the data2 that could be used as documentation. We will eventually use these comments to automatically build documentation and produce metadata. */
      data2: {
        type: ParameterType.STRING,
      },
    },
    // When working in a Javascript environment with no build, you will need to manually put the citations information.
    // You may find it useful to fill in the CITATION.cff file generated with this package and use this script to generate your citations:
    // https://github.com/jspsych/jsPsych/blob/main/packages/config/generateCitations.js
    // This is helpful for users of your plugin to easily cite it.
    citations: '__CITATIONS__', // prettier-ignore
  };

  return ExtensionNameExtension;
})(jsPsychModule);