supercharge / sttp

An HTTP client for a pleasant developer experience.

Sttp

An Axios wrapper for an enjoyable developer experience.

Installation · Resources

Follow @marcuspoehls and @superchargejs for updates!

---

Introduction

@supercharge/sttp is an elegant wrapper around the axios HTTP client. It provides a fluent interface allowing you to create HTTP requests communicating with other web applications.

Installation

npm i @supercharge/sttp

Resources

• 📖   Documentation

Contributing

Do you miss a string function? We very much appreciate your contribution! Please send in a pull request 😊

1. Create a fork
2. Create your feature branch: git checkout -b my-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request 🚀

License

MIT © Supercharge

---

superchargejs.com  ·  GitHub @supercharge  ·  Twitter @superchargejs

sttp's Issues

Nedd axios.all() functionality

What you provide in sttp.axios() is an AxiosInstance not AxiosStatic.

export interface AxiosInstance extends Axios {
  (config: AxiosRequestConfig): AxiosPromise;
  (url: string, config?: AxiosRequestConfig): AxiosPromise;
}

export interface AxiosStatic extends AxiosInstance {
  create(config?: AxiosRequestConfig): AxiosInstance;
  Cancel: CancelStatic;
  CancelToken: CancelTokenStatic;
  Axios: typeof Axios;
  readonly VERSION: string;
  isCancel(value: any): boolean;
  all<T>(values: Array<T | Promise<T>>): Promise<T[]>;
  spread<T, R>(callback: (...args: T[]) => R): (array: T[]) => R;
  isAxiosError(payload: any): payload is AxiosError;
}

Therefore, I cant use axios.all()

axios.all(promises.map((promise) => axios.get(promise))).then(
  axios.spread((user, repos, followers, following) => {
    console.log({ user, repos, followers, following });
  })
);

:)

Bug: withQueryParams merging object instead of replacing

Doesn't matter how you calling the withQueryParams the this.request.params gets merged with previous value.

In the scenario where I had a filter and now I'm removing the filter the
object params was:

this.request.params = {
    status: 1
}

Now I want to remove, I will the call the withQueryParams({}).... the result of this operation will result in the same filter I had before.

I would suggest refactoring the following:
https://github.com/supercharge/sttp/blob/main/src/sttp.ts#L122-L133

to:

withQueryParams (queryParams: object): this {
  this.request.params = queryParams

  return this
}

@marcuspoehls thoughts?

My workaround was to manually override the setting

_.set(instance.requestConfig(), 'params', undefined);

To add statusText in SttpResponse

Description
While the library has option to get the SttpResponse status method, It would be good to have the statusText which is missing. This might help show the message for technical support perspective in addition to status, specially when users sent screenshot of problem.

Solution
Exposing the statusText method.

Thank you for the great library.

Exposing axios instance for test

Description:
During tests is hard to mock the HTTP requests created by the Sttp library because the axios instance is set as private. Would be possible to expose the axios instance in the Sttp class?

Example:

import MockAdapter from 'axios-mock-adapter';

describe('My Test', () => {
    it('should be able to authenticate successfully', async () => {
      const mock = new MockAdapter(Sttp.axios);

      mock.onPost('https://api.auth.com/oauth/token').reply(200, {
        access_token: '123',
        refresh_token: 'v1.321',
        id_token: '1234',
        scope: 'openid profile email address phone offline_access',
        expires_in: 86400,
        token_type: 'Bearer',
      });

      const response = await Sttp.withBasicAuth('demo', 'demo')
        .withBaseUrl('https://api.auth.com')
        .post('/oauth/token', {....});

      expect(response).toMatchSnapshot();
    });
  });

Reference: