Merge pull request #126 from tjholm/options-requests

Add support for OPTIONS requests.

Author: tjholm

src/resources/api.test.ts

@@ -41,7 +41,7 @@ describe('Api', () => {
 			});
 
 			it("should provide Faas with ApiWorkerOptions", () => {
-				const expectedOpts = new ApiWorkerOptions("main", "/newroute/", ['GET', 'POST', 'PATCH', 'PUT', 'DELETE']);
+				const expectedOpts = new ApiWorkerOptions("main", "/newroute/", ['GET', 'POST', 'PATCH', 'PUT', 'DELETE', 'OPTIONS']);
 				expect(faas.Faas).toBeCalledWith(expectedOpts)
 			});
 
@@ -52,7 +52,7 @@ describe('Api', () => {
 	});
 
 	// individual method handlers
-	["get", "post", "delete", "patch", "put"].forEach(method => {
+	["get", "post", "delete", "patch", "put", "options"].forEach(method => {
 		describe(`when creating a new ${method} handler`, () => {
 			beforeAll(async () => {
 				await api("main")[method]("/test/", mockFn)

src/resources/api.ts

@@ -115,14 +115,21 @@ class Route {
     return this.method(['DELETE'], ...middleware);
   }
 
+  /**
+   * Register a handler function for OPTIONS requests to this route
+   */
+  async options(...middleware: HttpMiddleware[]): Promise<void> {
+    return this.method(['OPTIONS'], ...middleware);
+  }
+
   /**
    * Register a handler function for GET, POST, PATCH, PUT and DELETE requests to this route.
    *
    * Most useful when routing isn't important or you're doing you own internal routing.
    */
   async all(...middleware: HttpMiddleware[]): Promise<void> {
     return this.method(
-      ['GET', 'POST', 'PATCH', 'PUT', 'DELETE'],
+      ['GET', 'POST', 'PATCH', 'PUT', 'DELETE', 'OPTIONS'],
       ...middleware
     );
   }
@@ -246,6 +253,17 @@ class Api {
     const r = this.route(match);
     return r.delete(...middleware);
   }
+
+  /**
+   * Registers a new route with a OPTIONS handler in a single method.
+   * @param match the route path matcher e.g. '/home'. Supports path params via colon prefix e.g. '/customers/:customerId'
+   * @param middleware the middleware/handler to register for calls to DELETE
+   * @returns {Promise} that resolves when the handler terminates.
+   */
+   async options(match: string, ...middleware: HttpMiddleware[]): Promise<void> {
+    const r = this.route(match);
+    return r.options(...middleware);
+  }
 }
 
 /**

src/types.ts

@@ -78,4 +78,4 @@ export type WhereQueryOperator =
 
 export type WhereValueExpression = string | number | boolean;
 
-export type HttpMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
+export type HttpMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE' | 'OPTIONS';