pa11y-webservice-client-node is a Node.js client library for pa11y-webservice
pa11y-webservice-client-node is a Node.js client library for pa11y-webservice.
Install pa11y-webservice-client-node with npm:
$ npm install pa11y-webservice-client-node
For more information on the actual web-service 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;
To develop pa11y-webservice-client-node, 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.