feat: add missing http methods (#26)

* feat: add support for missing http methods

HEAD, OPTIONS, CONNECT, TRACE, QUERY
Note that query is being discussed in an RFC, link in code

* chore: update dist

* docs

Author: albertodeago

README.md

@@ -33,13 +33,15 @@ Currently the library export just CurlGenerator, and it's a function with just 1
 ```js
 /**
  * @param {string} url - the request url
- * @param {string} [param.method] - a value between ("GET" | "POST" | "PUT" | "PATCH" | "DELETE") it's case insensitive
+ * @param {string} [param.method] - a value between ("GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS" | "CONNECT" | "TRACE" | "QUERY") it's case insensitive
  * @param {Object<string, string>} [param.headers] - an object containing the headers of the request
  * @param {Object} [body] - the body of the request
  */
 ```
 
-Example of a more "andvanced" use
+**Note:** The QUERY method is not yet an official HTTP standard but is based on an [IETF draft proposal](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-safe-method-w-body).
+
+Example of a more "advanced" use
 ```js
 import {CurlGenerator} from "curl-generator";
 

dist/curl-generator.cjs.js

@@ -100,6 +100,11 @@ var getCurlMethod = function (method) {
             PUT: "-X PUT",
             PATCH: "-X PATCH",
             DELETE: "-X DELETE",
+            HEAD: "-X HEAD",
+            OPTIONS: "-X OPTIONS",
+            CONNECT: "-X CONNECT",
+            TRACE: "-X TRACE",
+            QUERY: "-X QUERY",
         };
         result = " " + types[method.toUpperCase()];
     }

dist/curl-generator.esm.js

@@ -96,6 +96,11 @@ var getCurlMethod = function (method) {
             PUT: "-X PUT",
             PATCH: "-X PATCH",
             DELETE: "-X DELETE",
+            HEAD: "-X HEAD",
+            OPTIONS: "-X OPTIONS",
+            CONNECT: "-X CONNECT",
+            TRACE: "-X TRACE",
+            QUERY: "-X QUERY",
         };
         result = " " + types[method.toUpperCase()];
     }

dist/curl-generator.umd.js

@@ -102,6 +102,11 @@
               PUT: "-X PUT",
               PATCH: "-X PATCH",
               DELETE: "-X DELETE",
+              HEAD: "-X HEAD",
+              OPTIONS: "-X OPTIONS",
+              CONNECT: "-X CONNECT",
+              TRACE: "-X TRACE",
+              QUERY: "-X QUERY",
           };
           result = " " + types[method.toUpperCase()];
       }

dist/main.d.ts

@@ -48,7 +48,7 @@ declare type CurlAdditionalOptions = {
     verbose?: boolean;
 };
 declare type CurlRequest = {
-    method?: "GET" | "get" | "POST" | "post" | "PUT" | "put" | "PATCH" | "patch" | "DELETE" | "delete";
+    method?: "GET" | "get" | "POST" | "post" | "PUT" | "put" | "PATCH" | "patch" | "DELETE" | "delete" | "HEAD" | "head" | "OPTIONS" | "options" | "CONNECT" | "connect" | "TRACE" | "trace" | "QUERY" | "query";
     headers?: StringMap;
     body?: CurlBody;
     url: string;

src/main.ts

@@ -49,7 +49,8 @@ type CurlAdditionalOptions = {
 };
 
 type CurlRequest = {
-  method?: "GET" | "get" | "POST" | "post" | "PUT" | "put" | "PATCH" | "patch" | "DELETE" | "delete",
+  // 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",
   headers?: StringMap,
   body?: CurlBody,
   url: string,
@@ -72,6 +73,11 @@ const getCurlMethod = function (method?: string): string {
       PUT: "-X PUT",
       PATCH: "-X PATCH",
       DELETE: "-X DELETE",
+      HEAD: "-X HEAD",
+      OPTIONS: "-X OPTIONS",
+      CONNECT: "-X CONNECT",
+      TRACE: "-X TRACE",
+      QUERY: "-X QUERY",
     };
     result = ` ${types[method.toUpperCase()]}`;
   }