Skip to content

Document the location of the JavaScript API #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Document the location of the JavaScript API #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions pages/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@

# Application Programming Interface

JSHint exposes a JavaScript API for programmatic access in environments like
web browsers and [Node.js](https://nodejs.org).
JSHint exposes a JavaScript API for programmatic interaction. When the source
file is included in web browser environments via a `<script>` tag, this API is
available via a global binding named `JSHINT` (i.e. `window.JSHINT`). When
JSHint is loaded in as a CommonJS module (for example, in
[Node.js](https://nodejs.org)), the API is available via the `JSHINT` property
of that module (i.e. `require('jshint').JSHINT`).

## `JSHINT( source, options, predef )`

Expand Down