Skip to content

Commit ca5991e

Browse files
author
Patrick Sachs
authored
Fixed typos and updated documentation
1 parent 4876c42 commit ca5991e

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ npm install @sahnee/ajax
1212

1313
This library provides a simple to use API to make AJAX calls using fetch. If your browser does not support fetch (e.g. IE11) you need to provide a polyfill on your end.
1414

15-
This readme will provide a short overview of many basic functions, however your are urged to read the documentation included in the source for before using.
15+
This readme will provide a short overview of many basic functions, however your are urged to read the documentation included in the source before using.
1616

1717
### Simple AJAX request
1818

@@ -93,6 +93,8 @@ import { defaultInit } from '@sahnee/ajax';
9393
defaultInit.headers['x-auth'] = 'my-auth-token-123';
9494
```
9595

96+
The default options will also be applied to the result of the `url` function.
97+
9698
## Important differences to fetch
9799

98100
- By default non success status codes will raise an `APIError`. This can be disabled by setting the `allowNonSuccessStatusCode` option to `true`.

0 commit comments

Comments
 (0)