Skip to content

Commit

Permalink
Documenting the HTTP Basic auth request config
Browse files Browse the repository at this point in the history
  • Loading branch information
idan committed Dec 9, 2015
1 parent 19cbca0 commit e270c70
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Expand Up @@ -215,6 +215,14 @@ These are the available config options for making requests. Only the `url` is re
// should be made using credentials
withCredentials: false, // default

// `auth` indicates that HTTP Basic auth should be used, and supplies credentials.
// The username can be supplied as `user` or `username`
// The password can be supplied as `pass` or `password`
auth: {
user: 'janedoe',
pass: 's00pers3cret'
}

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

0 comments on commit e270c70

Please sign in to comment.