feat: provide TS auto-completion for HTTP methods, but allow any custom string

Author: albertodeago

example/parameters.ts

@@ -195,3 +195,8 @@ export const jsonBody = {
     },
   },
 };
+
+export const customMethod = {
+  url: "https://jsonplaceholder.typicode.com/posts",
+  method: "Cheese",
+};

src/main.ts

@@ -50,7 +50,8 @@ type CurlAdditionalOptions = {
 
 type CurlRequest = {
   // Query is not official HTTP method, but it's in a RFC and we want to support it. https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-safe-method-w-body
-  method?: "GET" | "get" | "POST" | "post" | "PUT" | "put" | "PATCH" | "patch" | "DELETE" | "delete" | "HEAD" | "head" | "OPTIONS" | "options" | "CONNECT" | "connect" | "TRACE" | "trace" | "QUERY" | "query",
+  // All the list of values provide TS auto-completion, but still allow custom methods as string. This is to support non-standard methods like "Cheese"
+  method?: "GET" | "get" | "POST" | "post" | "PUT" | "put" | "PATCH" | "patch" | "DELETE" | "delete" | "HEAD" | "head" | "OPTIONS" | "options" | "CONNECT" | "connect" | "TRACE" | "trace" | "QUERY" | "query" | (string & {}),
   headers?: StringMap,
   body?: CurlBody,
   url: string,

test/__snapshots__/main.test.ts.snap

@@ -1,5 +1,10 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`customMethod 1`] = `
+"curl https://jsonplaceholder.typicode.com/posts \\
+ undefined"
+`;
+
 exports[`del1 1`] = `
 "curl https://jsonplaceholder.typicode.com/posts/1 \\
  -X DELETE"