Pa11y Webservice Node.js Client
This is a Node.js client library for Pa11y Webservice.
Install Pa11y Webservice Node.js Client with npm:
$ npm install pa11y-webservice-client-node
For more information on the actual webservice endpoints and resource types, read the documentation.
var createClient = ;// Create client with the base URL of the web-servicevar client = ;// Create a taskclienttasks;// Get all tasksclienttasks;// Get all tasks with last results included for eachclienttasks;// Get results for all tasksclienttasks;// Get results for all tasks within a date rangeclienttasks;// Get results for all tasks with full detailsclienttasks;// Get a task by IDclient;// Get a task by ID with last results includedclient;// Edit a task by IDclient;// Delete a task by IDclient;// Run a task by IDclient;// Get results for a taskclient;// Get results for a task within a date rangeclient;// Get results for a task with full detailsclient;// Get a result by IDclient;// Get a result by ID with full detailsclient;
There are many ways to contribute to Pa11y Webservice Node.js Client, we cover these in the contributing guide for this repo.
If you're ready to contribute some code, you'll need to clone the repo locally and run
npm install. You'll also need Grunt to be installed globally in order to run tests, you can do this with
npm install -g grunt-cli.
Now you'll be able to run the following commands:
$ grunt # Run the lint and test tasks together$ grunt lint # Run JSHint with the correct config$ grunt test # Run unit tests
Code with lint errors or failing tests will not be accepted, please use the build tools outlined above.
For users with push-access, don't commit to the master branch. Code should be in
develop until it's ready to be released.
Support and Migration
Major versions are normally supported for 6 months after their last minor release. This means that patch-level changes will be added and bugs will be fixed. The table below outlines the end-of-support dates for major versions, and the last minor release for that version.
We also maintain a migration guide to help you migrate.
|❔||Major Version||Last Release||Node.js Versions||Support End Date|
If you're opening issues related to these, please mention the version that the issue relates to.
Licensed under the GNU General Public License 3.0.
Copyright © 2013–2019, Team Pa11y