dpd.js
is an auto-generated library that updates as you update the resources in your Deployd API. If you are writing your front-end in the public
directory, include a script tag tag in your HTML:
<script src="/dpd.js" type="text/javascript"></script>
Note: The dpd.js file will not appear in the public
directory because it is generated at runtime.
dpd.todos.get(function(todos, error) {
if (error) {
alert(error.message);
} else {
for (var i = 0; i < todos.length; i++) {
renderTodo(todos[i]);
};
}
});
Dpd.js functions are asynchronous: they do not return a value, but execute a callback function when the AJAX operation is complete.
// Does not work
var result = dpd.todos.get();
// Works as expected
dpd.todos.get(function(result, error) {
// Work with result
});
For details on using dpd.js, see the dpd.js reference
Also see A Simple Todo App for a working example.
You can use the dpd.js library outside of the public
folder by using an absolute URL to the file.
This will not work on browsers that do not support Cross-Origin Resource Sharing (namely Internet Explorer 7 and below).
The dpd.js library is not required; it is only a utility library for accessing Deployd's HTTP API with AJAX. For details on the HTTP API, see the HTTP API Refernence.
Some front-end libraries include support for HTTP or REST APIs; for examples of how to use these instead of dpd.js, see A Simple Todo App with Backbone and A Simple Todo App with AngularJS
Let us know if you have any ideas to improve our docs. Open an issue on github, send us an email, or tweet us.
This entire site, including documentation written in markdown is available on github. Pull requests are appreciated!