ThrowOnError not working

[paulkre]

Description

When setting ThrowOnError to true, the function still returns the error as part of the result. The function only throws when there is some kind of network error. This can't be the intended behavior, because the return type of the function is {data, request, response}, allowing no way to handle the error.

[bolt-new-by-stackblitz]

Start a new pull request in StackBlitz Codeflow.

• hey-api-client-fetch-example (Open reproduction)

[mrlubos]

@paulkre hey, can you share a reproducible example?

[flipvh]

@paulkre you are setting it on the function and/or in the config? When @mrlubos I set it in the createClientConfig I expected it to become the default, but I still need to include it in every function? Is that by design? For me it would be amazing if what you have in the config can become the default for all functions unless they overrule it on a per function basis.

EDIT: my implementation now looks like this:

export const createClientConfig: CreateClientConfig = (baseConfig) => ({
  ...baseConfig,
  baseUrl: config.backendUrl,
  responseStyle: 'data',
  throwOnError: true,
  fetch: async (input: RequestInfo | URL, init?: RequestInit) => {
    const response = await fetch(input, { ...(init ?? {}), credentials: 'include' });
    
    if (response.ok) return response; 
    
    const json = await response.json();

    if ('error' in json) throw new ApiError(json.error);

    throw new Error('Unknown error');
  }
});

[paulkre]

For me, it doesn't matter, where I specify the error handling method, it always behaves incoherently. If I set throwOnError to false in the options and also set the generic parameter ThrowOnError to false in the function call, the function will still throw if the fetch causes a net::ERR_CONNECTION_REFUSED error.

I think it would be confusing if this library expects the user to handle network errors separately from API errors. This would force everyone to wrap all request function calls in try/catch blocks, regardless of the ThrowOnError value.