vndb/mithril-vndb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve docs

Browse source
This commit is contained in:
Leo Horie 2014-09-14 00:22:00 -04:00
parent 81fc994954
commit 8c3467b819
10 changed files with 171 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/mithril.request.md
View file

@ -1,5 +1,23 @@
## m.request
---
[Basic usage](#basic-usage)
[Processing-web-service-data](#processing-web-service-data)
[Bind redirection code](#bind-redirection-code)
[Binding errors](#binding-errors)
[Queuing operations](#queuing-operations)
[Casting the Response Data to a Class](#casting-the-response-data-to-a-class)
[Unwrapping Response Data](#unwrapping-response-data)
[Using Different Data Transfer Formats](#using-different-data-transfer-formats)
[Using variable data formats](#using-variable-data-formats)
[Extracting Metadata from the Response](#extracting-metadata-from-the-response)
[Configuring the underlying XMLHttpRequest](#configuring-the-underlying-xmlhttprequest)
[Aborting a request](#aborting-a-request)
[Signature](#signature)
---
This is a high-level utility for working with web services, which allows writing asynchronous code relatively procedurally.
By default, it assumes server responses are in JSON format and optionally instantiates a class with the response data.