Documentation needs to say that refreshAuthLogic needs to return the axios instance about axios-auth-refresh

[Flyrell]

Hi @thomergil, thanks for submitting the issue.

Yes I'm aware that skipWhileRefreshing: false is required and I plan to change it as soon as possible in the v3 of the library.

Please, understand this is something I do in my free time while I'm working on other projects/libraries. If you'd like to fast-forward the development process, please consider contributing if that's something you'd be able to do. I'd be more than happy to do a code review & accept any pull requests on this package.

When it comes to the documentation, there's no return statement because of how the arrow functions work. When only one statement is executed and there's no wrapping curly braces {} the statement will be returned automatically. Although it's correct, I agree that the function can be written in {} and return the statement, so the people seeing it will actually realise that the return is necessary for the library to work.

[Flyrell]

I plan to include this change in v3.0.0 [PR #105].

[SerhiyRomanov]

I agree with @thomergil because I am faced with the same error. I resolved it only after reading this issue.

[vinurs]

@SerhiyRomanov me too

[Shaddix]

I was a bit confused by the statement in the initial message:

Secondly, documentation is unclear. It needs to mention that refreshAuthLogic needs to return the axios instance:

It seems to me, that refreshAuthLogic should return Promise, not the axios instance (at least, that's what I got from the docs, and that's what I'm doing currently and it seems to work).

If my assumption is true, please confirm, that it's ok to return simple Promise from that method :)

[Flyrell]

@Shaddix yes, you're right. It's enough to return any Promise, which triggers the stalled requests to run once again.

I think what author meant was that the example in documentation uses an arrow function to return the axios call (not instance) and there's no return statement, which might be confusing for some people.

[Flyrell]

Done, merged and published in #111.