Interceptor return types are incorrect.

[plwalters]

The return types should match the fetch spec, in particular the requestError and responseErrors should have valid return types (they do not appear to from what I can tell)

[plwalters]

I'm looking in to this now to see if the description is correct or the docs are incorrect, either way I will tidy this one up.

[plwalters]

Ok sorry looks like requestError expects for a return type of the RequestMessage but I'm not sure where that should be derived from, could by my mistake. responseErrors looks good.

[AMCN41R]

I'm experiencing an issue related to the return types in a typescript project.

The docs, under Basic Http Interceptors, show that you can 'throw error' for requestError and responseError, but this does not compile due to the type definitions expecting the return type to be RequestMessage | Promise<RequestMessage> and HttpResponseMessage | Promise<HttpResponseMessage> respectively.

For example, the following interceptor...

export class MyInterceptor implements Interceptor {
    responseError(error: HttpResponseMessage) {
        throw error;
    }
}

results in...

'Class 'MyInterceptor' incorrectly implements interface 'Interceptor'.
  Types of property 'responseError' are incompatible.
    Type '(error: HttpResponseMessage) => void' is not assignable to type '(error: HttpResponseMessage) => HttpResponseMessage | Promise<HttpResponseMessage>'.
      Type 'void' is not assignable to type 'HttpResponseMessage | Promise<HttpResponseMessage>'.'

I can fix this by changing throw error to return Promise.reject<HttpResponseMessage>(error)

However, doing the same for requestError would look like...

export class MyInterceptor implements Interceptor {
    requestError(error: Error) {
        return Promise.reject<RequestMessage>(error);
    }
}

Is that right?

[loku02]

Any movement regarding this topic?

[djensen47]

All of the documentation for the fetch client needs to be refreshed. The API docs are incomplete and the example usage here is also possibly incorrect: http://aurelia.io/docs/plugins/http-services#aurelia-fetch-client

[Alexander-Taran]

Would you like to provide a pull request for it @djensen47 ?

[djensen47]

I need to figure out how the project documentation works. I probably won't be able to get to that for a few days/weeks.

[Alexander-Taran]

I could point you in right direction. (-:
https://github.com/aurelia/fetch-client/blob/master/doc/article/en-US/http-services.md

[djensen47]

Thanks! How do the API docs work? I think that has the bigger issue of no documentation. Or at the very least, I would start with the API docs, then make sure that the guide is correct (or if I have to eat my hat 😉 🍽 🎩 ).

[Alexander-Taran]

Api docs are automated in collecting annotations. Mostly.

[Alexander-Taran]

@bigopon maybe can be closed