Skip to content
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.

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

Update DataAdapterMixin docs #1366

Merged
merged 2 commits into from
Jun 7, 2017
Merged
Changes from all commits
Commits
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
14 changes: 10 additions & 4 deletions addon/mixins/data-adapter-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,11 @@ export default Mixin.create({
specific header name and contents depend on the actual authorizer that is
used.

This method applies for Ember Data 2.6 and older. See `headersForRequest`
for newer versions of Ember Data.
Until [emberjs/rfcs#171](https://github.com/emberjs/rfcs/pull/171)
gets resolved and [ds-improved-ajax](https://github.com/emberjs/data/pull/3099)
[feature flag](https://github.com/emberjs/data/blob/master/FEATURES.md#feature-flags)
is enabled, this method will be called for **every** ember-data version.
`headersForRequest` *should* replace it after the resolution of the RFC.

@method ajaxOptions
@protected
Expand All @@ -92,8 +95,11 @@ export default Mixin.create({
Adds request headers containing the authorization data as constructed
by the {{#crossLink "DataAdapterMixin/authorizer:property"}}{{/crossLink}}.

This method will only be called in Ember Data 2.7 or greater. Older versions
will rely on `ajaxOptions` for request header injection.
Until [emberjs/rfcs#171](https://github.com/emberjs/rfcs/pull/171)
gets resolved and [ds-improved-ajax](https://github.com/emberjs/data/pull/3099)
[feature flag](https://github.com/emberjs/data/blob/master/FEATURES.md#feature-flags)
is enabled, this method will **not** be used.
See `ajaxOptions` instead.

@method headersForRequest
@protected
Expand Down