Skip to content

Commit 8b70995

Browse files
committed
Updated DSHttpAdapter api docs
1 parent f6d040a commit 8b70995

File tree

3 files changed

+251
-234
lines changed

3 files changed

+251
-234
lines changed

dist/angular-data.js

+14-5
Original file line numberDiff line numberDiff line change
@@ -1442,9 +1442,20 @@ function DSHttpAdapterProvider() {
14421442
* @description
14431443
* Transform the angular-data query to something your server understands. You might just do this on the server instead.
14441444
*
1445+
* ## Example:
1446+
* ```js
1447+
* DSHttpAdapterProvider.defaults.queryTransform = function (resourceName, params) {
1448+
* if (params && params.userId) {
1449+
* params.user_id = params.userId;
1450+
* delete params.userId;
1451+
* }
1452+
* return params;
1453+
* };
1454+
* ```
1455+
*
14451456
* @param {string} resourceName The name of the resource.
1446-
* @param {object} params Params sent through from `$http()`.
1447-
* @returns {*} Returns `params` as-is.
1457+
* @param {object} params Params that will be passed to `$http`.
1458+
* @returns {*} By default just returns `params` as-is.
14481459
*/
14491460
queryTransform: function (resourceName, params) {
14501461
return params;
@@ -1463,9 +1474,7 @@ function DSHttpAdapterProvider() {
14631474
* angular.extend(DSHttpAdapterProvider.defaults.$httpConfig, {
14641475
* interceptor: [...],
14651476
* headers: {
1466-
* common: {
1467-
* Authorization: 'Basic YmVlcDpib29w'
1468-
* }
1477+
* Authorization: 'Basic YmVlcDpib29w'
14691478
* },
14701479
* timeout: 20000
14711480
* });

guide/home.html

+6
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,12 @@ <h1>Respect your data</h1>
7373
<br>
7474
Angular-data does not require angular-cache in order to work.
7575
</p>
76+
77+
<p>
78+
<strong>Now what?</strong>
79+
<br>
80+
<a href="/documentation/guide/angular-data/overview">Dive in!</a>
81+
</p>
7682
</div>
7783
</div>
7884
</div>

0 commit comments

Comments
 (0)