For the complete documentation index, see llms.txt. This page is also available as Markdown.

Service connection

These options tell WProofreader where to send spell check and grammar check requests.

Cloud

serviceId: 'your-service-ID'

You can find your Service ID on the Credentials page in the admin panel.

Self-hosted

serviceProtocol: 'https',
serviceHost: 'your_host_name',
servicePort: '443',
servicePath: 'wscservice/api'

You also need to point the wscbundle.js script src to your server. For NPM SDK integration, set the srcUrl option as well.

Request headers

If your server requires authentication, use the requestHeaders function to pass headers with every request. Only the Authorization header is supported. For cross-site requests, set withCredentials: true.

requestHeaders: function() {
  return {
    Authorization: 'Bearer ' + localStorage.getItem('authorization')
  };
},
withCredentials: true,

Last updated

Was this helpful?