README

jsPsych ID Plugin

A jsPsych plugin to get a participant's ID.

Usage

Installation

Install the package from npm (requires Node.js):

npm install --save @adp-psych/jspsych-plugin-id

Example

import jspsychPluginId from '@adp-psych/jspsych-plugin-id';
import {initJsPsych} from 'jspsych';

const PROLIFIC_ID_NAME = 'Prolific ID';

const checkProlificId = (id) => id !== '' && (/^\w{24}$/u).test(id);

const idTimelineNode = {
    'check_id': checkProlificId,
    'global_variable': 'participantId',
    'id_name': PROLIFIC_ID_NAME,
    'id_title': PROLIFIC_ID_NAME,
    'query_parameter': 'PROLIFIC_PID',
    'redact': true,
    'type': jspsychPluginId,
};

initJsPsych().run([idTimelineNode]);

Development

Cleaning

Remove generated files:

npm run clean

Documentation

Generate documentation into the doc directory with JSDoc:

npm run doc

Linting

Lint the project with ESLint and npm-package-json-lint:

npm run lint

Testing

Run unit tests:

npm run test

Dependencies

Check for new dependencies with npm-check:

npm run npm-check

Release

Publish a release with np:

npm run release

Legal Information

Copyright

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Usage no npm install needed!