Please rename .del to .delete because of TS

[Sawtaytoes]

Description

I'm using TypeScript and had a hell of a time trying to figure out why my types for paths 2nd level didn't match the types for the functions on createClient. I believe it's because of del. Wasted 10 hours on this because it's so hard to catch.

I wrapped createClient, so I could use it in a React context with react-query through a helper hook. But I kept getting errors doing openapiFetchClient[method] where method was paths[Path].

TS was erroring, but the message was so convoluted. Even looking at the types, I couldn't tell what was wrong because I didn't have a delete in my paths only that TS wasn't happy about it.

Proposal

The types created from OpenAPI-TypeScript should 100% match the function names in createClient to allow easier wrapping of createClient with type-safety.

Please rename .del to .delete.

I had to rewrite the type of createClient to get it working (before I knew about the .del function). Because of rewriting that type, I ran into an issue where del didn't work, but now TS didn't error, and react-query ate the runtime error.

Checklist

• I’m willing to open a PR for this (see CONTRIBUTING.md)

[drwpow]

delete is a reserved word in JS, which means you couldn’t spread it, the original method couldn’t have that name, etc. It could only be named delete when it’s an object key. Though I agree it would be good to match the OpenAPI method. Let me see if there would be any potential footguns / bugs / confusion from this.

[Sawtaytoes]

I completely forgot about the reserved word. Been forever since I used it.

Confusion from using the keyword delete or naming the OpenAPI-TypeScript generation as del?

Another option is to name it DELETE and GET, etc and update OpenAPI-TypeScript as well. But who would assume an enum-style prop would be a function? Yuck.

[ysulyma]

I encountered this recently and just did

/**
 * Map HTTP method to the corresponding `openapi-fetch` method.
 * @param {string} str
 */
function methodName(str) {
  if (str === "delete") return "del";
  return str;
}

[ptlthg]

Another option is to name it DELETE and GET, etc and update OpenAPI-TypeScript as well. But who would assume an enum-style prop would be a function? Yuck.

Would just like to point out that this is the route SvelteKit took for similar reasons, and you can read the discussion here. Personally, I don't mind the capitalization and agree with the reasoning made there.

[drwpow]

Would just like to point out that this is the route SvelteKit took for similar reasons, and you can read the discussion here. Personally, I don't mind the capitalization and agree with the reasoning made there.

That’s some fantastic prior art and discussion. Thank you for sharing! I’m strongly inclined to copy this pattern (as a breaking change).

[drwpow]

v0.7.0 makes the breaking change of renaming all methods to uppercase. Which is annoying for some, but it’s made better by the fact that with pre-1.0 versions, minor can introduce breaking changes (and even utilities like pnpm update won’t bump minor 0.x versions).

[drwpow]

Hopefully this is an adequate fix to the issue! 🙂 Marking as closed, but still open to feedback here.

[Sawtaytoes]

Thanks for fixing this issue ;).