026fdb38a3
This is recommended to get proper stack traces, according to https://github.com/cujojs/when/blob/master/docs/api.md#a-note-on-javascript-errors. The new Error objects has the exact same properties as the objects we used to reject promises previously, thus this should be fully backwards compatible, but improve debuggability.
113 lines
2.9 KiB
Markdown
113 lines
2.9 KiB
Markdown
Mopidy.js
|
|
=========
|
|
|
|
Mopidy.js is a JavaScript library that is installed as a part of Mopidy's HTTP
|
|
frontend or from npm. The library makes Mopidy's core API available from the
|
|
browser or a Node.js environment, using JSON-RPC messages over a WebSocket to
|
|
communicate with Mopidy.
|
|
|
|
|
|
Getting it for browser use
|
|
--------------------------
|
|
|
|
Regular and minified versions of Mopidy.js, ready for use, is installed
|
|
together with Mopidy. When the HTTP frontend is running, the files are
|
|
available at:
|
|
|
|
- http://localhost:6680/mopidy/mopidy.js
|
|
- http://localhost:6680/mopidy/mopidy.min.js
|
|
|
|
You may need to adjust hostname and port for your local setup.
|
|
|
|
In the source repo, you can find the files at:
|
|
|
|
- `mopidy/http/data/mopidy.js`
|
|
- `mopidy/http/data/mopidy.min.js`
|
|
|
|
|
|
Getting it for Node.js use
|
|
--------------------------
|
|
|
|
If you want to use Mopidy.js from Node.js instead of a browser, you can install
|
|
Mopidy.js using npm:
|
|
|
|
npm install mopidy
|
|
|
|
After npm completes, you can import Mopidy.js using ``require()``:
|
|
|
|
var Mopidy = require("mopidy");
|
|
|
|
|
|
Using the library
|
|
-----------------
|
|
|
|
See the [Mopidy.js documentation](http://docs.mopidy.com/en/latest/api/js/).
|
|
|
|
|
|
Building from source
|
|
--------------------
|
|
|
|
1. Install [Node.js](http://nodejs.org/) and npm. If you're running Ubuntu:
|
|
|
|
sudo apt-get install nodejs-legacy npm
|
|
|
|
2. Enter the `js/` in Mopidy's Git repo dir and install all dependencies:
|
|
|
|
cd js/
|
|
npm install
|
|
|
|
That's it.
|
|
|
|
You can now run the tests:
|
|
|
|
npm test
|
|
|
|
To run tests automatically when you save a file:
|
|
|
|
npm start
|
|
|
|
To run tests, concatenate, minify the source, and update the JavaScript files
|
|
in `mopidy/http/data/`:
|
|
|
|
npm run-script build
|
|
|
|
To run other [grunt](http://gruntjs.com/) targets which isn't predefined in
|
|
`package.json` and thus isn't available through `npm run-script`:
|
|
|
|
PATH=./node_modules/.bin:$PATH grunt foo
|
|
|
|
|
|
Changelog
|
|
---------
|
|
|
|
### 0.3.0 (UNRELEASED)
|
|
|
|
- Upgrade to when.js 3, which brings great performance improvements and better
|
|
debugging facilities. If you maintain a Mopidy client, you should review the
|
|
[differences between when.js 2 and 3](https://github.com/cujojs/when/blob/master/docs/api.md#upgrading-to-30-from-2x)
|
|
and the
|
|
[when.js debugging guide](https://github.com/cujojs/when/blob/master/docs/api.md#debugging-promises).
|
|
|
|
- All promise rejection values are now of the Error type. This ensures that all
|
|
JavaScript VMs will show a useful stack trace if a rejected promise's value
|
|
is used to throw an exception.
|
|
|
|
### 0.2.0 (2014-01-04)
|
|
|
|
- **Backwards incompatible change for Node.js users:**
|
|
`var Mopidy = require('mopidy').Mopidy;` must be changed to
|
|
`var Mopidy = require('mopidy');`
|
|
|
|
- Add support for [Browserify](http://browserify.org/).
|
|
|
|
- Upgrade dependencies.
|
|
|
|
### 0.1.1 (2013-09-17)
|
|
|
|
- Upgrade dependencies.
|
|
|
|
### 0.1.0 (2013-03-31)
|
|
|
|
- Initial release as a Node.js module to the
|
|
[npm registry](https://npmjs.org/).
|