option or hook to trim parameters

[snebjorn]

I've got an interesting (annoying actually) problem. It basically boils down to the way URLSearchParams works.

Example

new URLSearchParams({ foo: "", bar: null, baz: undefined}).toString() // 'foo=&bar=null&baz=undefined'

The foo= and baz=undefined is rather unexpected - at least for me

The problem

Lets say we have the following client generated by orval

// pets.service.ts
searchPets<Pets>(params: SearchPetsParams): Observable<TData>;

// searchPetsParams.ts
export interface SearchPetsParams {
  foo: string | null;
  bar?: string | null;
};

In my app I have this

function searchPets(foo: string | null, bar?: string | null) {
  return petService.searchPets({ foo, bar });
}

Calling searchPets("test") will result in <url>?foo=test&bar=undefined

That's undesirable - IMO

The solution

I think it's safe to assume that foo= and baz=undefined can be stripped.

We could trim the parameters.

or

We could make a hook-thingy so users can transform/mutate api parameters.

Alternative

I tried trimming the parameters, but it leads to either unsafe parameter parsing or verbose code

function searchPets(foo: string | null, bar?: string | null) {
  // doesntBelong is not flagged as an invalid parameter
  return petService.searchPets(myTrimFn({ foo, bar, doesntBelong: 1 }));

  // here I have to import SearchPetsParams and manually add it to myTrimFn
  const params = myTrimFn<SearchPetsParams>({ foo, bar, doesntBelong: 1 }); // yay, doesntBelong is flagged as invalid
  return petService.searchPets(params);
}