diff options
Diffstat (limited to 'doc/development/fe_guide/axios.md')
| -rw-r--r-- | doc/development/fe_guide/axios.md | 18 |
1 files changed, 5 insertions, 13 deletions
diff --git a/doc/development/fe_guide/axios.md b/doc/development/fe_guide/axios.md index 6e7cf523f36..f8d301dac5e 100644 --- a/doc/development/fe_guide/axios.md +++ b/doc/development/fe_guide/axios.md @@ -1,13 +1,13 @@ # Axios -We use [axios][axios] to communicate with the server in Vue applications and most new code. +We use [axios](https://github.com/axios/axios) to communicate with the server in Vue applications and most new code. In order to guarantee all defaults are set you *should not use `axios` directly*, you should import `axios` from `axios_utils`. ## CSRF token All our request require a CSRF token. -To guarantee this token is set, we are importing [axios][axios], setting the token, and exporting `axios` . +To guarantee this token is set, we are importing [axios](https://github.com/axios/axios), setting the token, and exporting `axios` . This exported module should be used instead of directly using `axios` to ensure the token is set. @@ -32,19 +32,16 @@ This exported module should be used instead of directly using `axios` to ensure ## Mock axios response in tests -To help us mock the responses we are using [axios-mock-adapter][axios-mock-adapter]. +To help us mock the responses we are using [axios-mock-adapter](https://github.com/ctimmerm/axios-mock-adapter). -Advantages over [`spyOn()`]: +Advantages over [`spyOn()`](https://jasmine.github.io/api/edge/global.html#spyOn): - no need to create response objects - does not allow call through (which we want to avoid) - simple API to test error cases - provides `replyOnce()` to allow for different responses -We have also decided against using [axios interceptors] because they are not suitable for mocking. - -[axios interceptors]: https://github.com/axios/axios#interceptors -[`spyOn()`]: https://jasmine.github.io/api/edge/global.html#spyOn +We have also decided against using [axios interceptors](https://github.com/axios/axios#interceptors) because they are not suitable for mocking. ### Example @@ -77,8 +74,3 @@ Because polling function requires a header object, we need to always include an ```javascript mock.onGet('/users').reply(200, { foo: 'bar' }, {}); ``` - -[axios]: https://github.com/axios/axios -[axios-instance]: #creating-an-instance -[axios-interceptors]: https://github.com/axios/axios#interceptors -[axios-mock-adapter]: https://github.com/ctimmerm/axios-mock-adapter |