renaming xsrf to xsrfEnabled and defaulting to true

axios · Sep 2, 2015 · 7e2d6f7 · 7e2d6f7
1 parent c44f6a7
commit 7e2d6f7
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -182,8 +182,8 @@ This is the available config options for making requests. Only the `url` is requ
   // options are 'arraybuffer', 'blob', 'document', 'json', 'text'
   responseType: 'json', // default
 
-  // `xsrf` indicates whether or not cross-site request forgery protection is enabled
-  xsrf: false, // default
+  // `xsrfEnabled` indicates whether or not cross-site request forgery protection is enabled
+  xsrfEnabled: true, // default
 
   // `xsrfCookieName` is the name of the cookie to use as a value for xsrf token.
   // used only when `xsrf` is true

diff --git a/axios.d.ts b/axios.d.ts
@@ -39,7 +39,7 @@ declare module axios {
     data?: any;
     withCredentials?: boolean;
     responseType?: string;
-    xsrf?: boolean;
+    xsrfEnabled?: boolean;
     xsrfCookieName?: string;
     xsrfHeaderName?: string;
   }

diff --git a/lib/adapters/xhr.js b/lib/adapters/xhr.js
@@ -62,7 +62,7 @@ module.exports = function xhrAdapter(resolve, reject, config) {
     }
   };
 
-  if (config.xsrf) {
+  if (config.xsrfEnabled) {
     var cookies = require('./../helpers/cookies');
     var urlIsSameOrigin = require('./../helpers/urlIsSameOrigin');
 

diff --git a/lib/axios.js b/lib/axios.js
@@ -22,7 +22,7 @@ var axios = module.exports = function axios(config) {
     headers: {},
     transformRequest: defaults.transformRequest,
     transformResponse: defaults.transformResponse,
-    xsrf: false
+    xsrfEnabled: true
   }, config);
 
   // Don't allow overriding defaults.withCredentials

diff --git a/test/specs/xsrf.spec.js b/test/specs/xsrf.spec.js
@@ -14,8 +14,7 @@ describe('xsrf', function () {
     var request;
 
     axios({
-      url: '/foo',
-      xsrf: true
+      url: '/foo'
     });
 
     setTimeout(function () {
@@ -31,8 +30,7 @@ describe('xsrf', function () {
     document.cookie = axios.defaults.xsrfCookieName + '=12345';
 
     axios({
-      url: '/foo',
-      xsrf: true
+      url: '/foo'
     });
 
     setTimeout(function () {

diff --git a/test/typescript/axios.ts b/test/typescript/axios.ts
@@ -106,7 +106,7 @@ axios({
     },
     withCredentials: false, // default
     responseType: 'json', // default
-    xsrf: false, // default
+    xsrfEnabled: true, // default
     xsrfCookieName: 'XSRF-TOKEN', // default
     xsrfHeaderName: 'X-XSRF-TOKEN' // default
 });