Axios.rb

cheatsheet do
  title 'Axios'
  docset_file_name 'Axios'
  keyword 'axios'
  source_url 'http://cheat.kapeli.com'
  
  category do
    id 'General'
    
    entry do
      name 'GET request'
      notes <<-'END'
        ```javascript
        // Make a request for a user with a given ID
        axios.get('/user?ID=12345')
          .then(function (response) {
            console.log(response);
          })
          .catch(function (error) {
            console.log(error);
          });

        // Optionally the request above could also be done as
        axios.get('/user', {
            params: {
              ID: 12345
            }
          })
          .then(function (response) {
            console.log(response);
          })
          .catch(function (error) {
            console.log(error);
          });
        ```
      END
    end
    
    entry do
      name 'POST request'
      notes <<-'END'
        ```javascript
        axios.post('/user', {
            firstName: 'Fred',
            lastName: 'Flintstone'
          })
          .then(function (response) {
            console.log(response);
          })
          .catch(function (error) {
            console.log(error);
          });
        ```
      END
    end
    
    entry do
      name 'Multiple concurrent requests'
      notes <<-'END'
        ```javascript
        function getUserAccount() {
          return axios.get('/user/12345');
        }

        function getUserPermissions() {
          return axios.get('/user/12345/permissions');
        }

        axios.all([getUserAccount(), getUserPermissions()])
          .then(axios.spread(function (acct, perms) {
            // Both requests are now complete
          }));
        ```
      END
    end
    
    entry do
      name 'POST request config'
      notes <<-'END'
        ```javascript
        // Send a POST request
        axios({
          method: 'post',
          url: '/user/12345',
          data: {
            firstName: 'Fred',
            lastName: 'Flintstone'
          }
        });
        ```
      END
    end
    
    entry do
      name 'GET request config'
      notes <<-'END'
        ```javascript
        // GET request for remote image
        axios({
          method: 'get',
          url: 'http://bit.ly/2mTM3nY',
          responseType: 'stream'
        })
          .then(function(response) {
          response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
        });
        ```
      END
    end
    
    entry do
      name 'Create instance'
      notes <<-'END'
        ```javascript
        var instance = axios.create({
          baseURL: 'https://some-domain.com/api/',
          timeout: 1000,
          headers: {'X-Custom-Header': 'foobar'}
        });
        ```
      END
    end
  end
  
  category do
    id 'API'
    
    entry do
      name 'Request method aliases'
      notes <<-'END'
        ##### axios.request(config)
        ##### axios.get(url[, config])
        ##### axios.delete(url[, config])
        ##### axios.head(url[, config])
        ##### axios.options(url[, config])
        ##### axios.post(url[, data[, config]])
        ##### axios.put(url[, data[, config]])
        ##### axios.patch(url[, data[, config]])
      END
    end
    
    entry do
      name 'Concurrency'
      notes <<-'END'
        ##### axios.all(iterable)
        ##### axios.spread(callback)
      END
    end
    
    entry do
      name 'Instance methods'
      notes <<-'END'
        ##### axios#create([config])
        ##### axios#request(config)
        ##### axios#get(url[, config])
        ##### axios#delete(url[, config])
        ##### axios#head(url[, config])
        ##### axios#options(url[, config])
        ##### axios#post(url[, data[, config]])
        ##### axios#put(url[, data[, config]])
        ##### axios#patch(url[, data[, config]])
      END
    end
  end
  
  category do
    id 'Request Config'
    
    entry do
      name 'Request options'
      notes <<-'END'
        ```javascript
        {
          // `url` is the server URL that will be used for the request
          url: '/user',

          // `method` is the request method to be used when making the request
          method: 'get', // default

          // `baseURL` will be prepended to `url` unless `url` is absolute.
          // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs
          // to methods of that instance.
          baseURL: 'https://some-domain.com/api/',

          // `transformRequest` allows changes to the request data before it is sent to the server
          // This is only applicable for request methods 'PUT', 'POST', and 'PATCH'
          // The last function in the array must return a string or an instance of Buffer, ArrayBuffer,
          // FormData or Stream
          // You may modify the headers object.
          transformRequest: [function (data, headers) {
            // Do whatever you want to transform the data

            return data;
          }],

          // `transformResponse` allows changes to the response data to be made before
          // it is passed to then/catch
          transformResponse: [function (data) {
            // Do whatever you want to transform the data

            return data;
          }],

          // `headers` are custom headers to be sent
          headers: {'X-Requested-With': 'XMLHttpRequest'},

          // `params` are the URL parameters to be sent with the request
          // Must be a plain object or a URLSearchParams object
          params: {
            ID: 12345
          },

          // `paramsSerializer` is an optional function in charge of serializing `params`
          // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
          paramsSerializer: function(params) {
            return Qs.stringify(params, {arrayFormat: 'brackets'})
          },

          // `data` is the data to be sent as the request body
          // Only applicable for request methods 'PUT', 'POST', and 'PATCH'
          // When no `transformRequest` is set, must be of one of the following types:
          // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
          // - Browser only: FormData, File, Blob
          // - Node only: Stream, Buffer
          data: {
            firstName: 'Fred'
          },

          // `timeout` specifies the number of milliseconds before the request times out.
          // If the request takes longer than `timeout`, the request will be aborted.
          timeout: 1000,

          // `withCredentials` indicates whether or not cross-site Access-Control requests
          // should be made using credentials
          withCredentials: false, // default

          // `adapter` allows custom handling of requests which makes testing easier.
          // Return a promise and supply a valid response (see lib/adapters/README.md).
          adapter: function (config) {
            /* ... */
          },

          // `auth` indicates that HTTP Basic auth should be used, and supplies credentials.
          // This will set an `Authorization` header, overwriting any existing
          // `Authorization` custom headers you have set using `headers`.
          auth: {
            username: 'janedoe',
            password: 's00pers3cret'
          },

          // `responseType` indicates the type of data that the server will respond with
          // options are 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
          responseType: 'json', // default

          // `xsrfCookieName` is the name of the cookie to use as a value for xsrf token
          xsrfCookieName: 'XSRF-TOKEN', // default

          // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
          xsrfHeaderName: 'X-XSRF-TOKEN', // default

          // `onUploadProgress` allows handling of progress events for uploads
          onUploadProgress: function (progressEvent) {
            // Do whatever you want with the native progress event
          },

          // `onDownloadProgress` allows handling of progress events for downloads
          onDownloadProgress: function (progressEvent) {
            // Do whatever you want with the native progress event
          },

          // `maxContentLength` defines the max size of the http response content allowed
          maxContentLength: 2000,

          // `validateStatus` defines whether to resolve or reject the promise for a given
          // HTTP response status code. If `validateStatus` returns `true` (or is set to `null`
          // or `undefined`), the promise will be resolved; otherwise, the promise will be
          // rejected.
          validateStatus: function (status) {
            return status >= 200 && status < 300; // default
          },

          // `maxRedirects` defines the maximum number of redirects to follow in node.js.
          // If set to 0, no redirects will be followed.
          maxRedirects: 5, // default

          // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
          // and https requests, respectively, in node.js. This allows options to be added like
          // `keepAlive` that are not enabled by default.
          httpAgent: new http.Agent({ keepAlive: true }),
          httpsAgent: new https.Agent({ keepAlive: true }),

          // 'proxy' defines the hostname and port of the proxy server
          // Use `false` to disable proxies, ignoring environment variables.
          // `auth` indicates that HTTP Basic auth should be used to connect to the proxy, and
          // supplies credentials.
          // This will set an `Proxy-Authorization` header, overwriting any existing
          // `Proxy-Authorization` custom headers you have set using `headers`.
          proxy: {
            host: '127.0.0.1',
            port: 9000,
            auth: {
              username: 'mikeymike',
              password: 'rapunz3l'
            }
          },

          // `cancelToken` specifies a cancel token that can be used to cancel the request
          // (see Cancellation section below for details)
          cancelToken: new CancelToken(function (cancel) {
          })
        }
        ```
      END
    end
  end
  
  category do
    id 'Response Schema'
    
    entry do
      name 'Request response'
      notes <<-'END'
        ```javascript
        {
          // `data` is the response that was provided by the server
          data: {},

          // `status` is the HTTP status code from the server response
          status: 200,

          // `statusText` is the HTTP status message from the server response
          statusText: 'OK',

          // `headers` the headers that the server responded with
          // All header names are lower cased
          headers: {},

          // `config` is the config that was provided to `axios` for the request
          config: {},

          // `request` is the request that generated this response
          // It is the last ClientRequest instance in node.js (in redirects)
          // and an XMLHttpRequest instance the browser
          request: {}
        }
        ```
      END
    end
  
    entry do
      name 'Response using `then`'
      notes <<-'END'
        ```javascript
        axios.get('/user/12345')
          .then(function(response) {
            console.log(response.data);
            console.log(response.status);
            console.log(response.statusText);
            console.log(response.headers);
            console.log(response.config);
          });
        ```
      END
    end
  end
  
  category do
    id 'Config Defaults'
    
    entry do
      name 'Global axios defaults'
      notes <<-'END'
        ```javascript
        axios.defaults.baseURL = 'https://api.example.com';
        axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
        axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';
        ```
      END
    end
    
    entry do
      name 'Custom instance defaults'
      notes <<-'END'
        ```javascript
        // Set config defaults when creating the instance
        var instance = axios.create({
          baseURL: 'https://api.example.com'
        });

        // Alter defaults after instance has been created
        instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;
        ```
      END
    end
    
    entry do
      name 'Config order of precedence'
      notes <<-'END'
        ```javascript
        // Create an instance using the config defaults provided by the library
        // At this point the timeout config value is `0` as is the default for the library
        var instance = axios.create();

        // Override timeout default for the library
        // Now all requests will wait 2.5 seconds before timing out
        instance.defaults.timeout = 2500;

        // Override timeout for this request as it's known to take a long time
        instance.get('/longRequest', {
          timeout: 5000
        });
        ```
      END
    end
  end
  
  category do
    id 'Interceptors'
    
    entry do
      name 'Intercept request/responses'
      notes <<-'END'
        ```javascript
        // Add a request interceptor
        axios.interceptors.request.use(function (config) {
            // Do something before request is sent
            return config;
          }, function (error) {
            // Do something with request error
            return Promise.reject(error);
          });

        // Add a response interceptor
        axios.interceptors.response.use(function (response) {
            // Do something with response data
            return response;
          }, function (error) {
            // Do something with response error
            return Promise.reject(error);
          });
        ```
      END
    end
    
    entry do
      name 'Remove interceptor'
      notes <<-'END'
        ```javascript
        var myInterceptor = axios.interceptors.request.use(function () {/*...*/});
        axios.interceptors.request.eject(myInterceptor);
        ```
      END
    end
    
    entry do
      name 'Custom instance interceptors'
      notes <<-'END'
        ```javascript
        var instance = axios.create();
        instance.interceptors.request.use(function () {/*...*/});
        ```
      END
    end
  end
  
  category do
    id 'Handling Errors'
    
    entry do
      name 'Catch error'
      notes <<-'END'
        ```javascript
        axios.get('/user/12345')
          .catch(function (error) {
            if (error.response) {
              // The request was made and the server responded with a status code
              // that falls out of the range of 2xx
              console.log(error.response.data);
              console.log(error.response.status);
              console.log(error.response.headers);
            } else if (error.request) {
              // The request was made but no response was received
              // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
              // http.ClientRequest in node.js
              console.log(error.request);
            } else {
              // Something happened in setting up the request that triggered an Error
              console.log('Error', error.message);
            }
            console.log(error.config);
          });
        ```
      END
    end
    
    entry do
      name 'Custom HTTP status code error'
      notes <<-'END'
        ```javascript
        axios.get('/user/12345', {
          validateStatus: function (status) {
            return status < 500; // Reject only if the status code is greater than or equal to 500
          }
        })
        ```
      END
    end
  end
  
  category do
    id 'Cancellation'
    
    entry do
      name 'Cancel request with cancel token'
      notes <<-'END'
        ```javascript
        var CancelToken = axios.CancelToken;
        var source = CancelToken.source();

        axios.get('/user/12345', {
          cancelToken: source.token
        }).catch(function(thrown) {
          if (axios.isCancel(thrown)) {
            console.log('Request canceled', thrown.message);
          } else {
            // handle error
          }
        });

        axios.post('/user/12345', {
          name: 'new name'
        }, {
          cancelToken: source.token
        })

        // cancel the request (the message parameter is optional)
        source.cancel('Operation canceled by the user.');
        ```
      END
    end
    
    entry do
      name 'Create cancel token'
      notes <<-'END'
        ```javascript
        var CancelToken = axios.CancelToken;
        var cancel;

        axios.get('/user/12345', {
          cancelToken: new CancelToken(function executor(c) {
            // An executor function receives a cancel function as a parameter
            cancel = c;
          })
        });

        // cancel the request
        cancel();
        ```
      END
    end
  end
end