Add type for valid fetch methods (#857)

* Add type for valid fetch methods * Address feedback
coda · Mar 15, 2021 · 95b0e71 · 95b0e71
1 parent 3e9d4dc
commit 95b0e71
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 4 deletions.
diff --git a/api_types.ts b/api_types.ts
@@ -135,10 +135,18 @@ export interface Network {
 }
 
 // Fetcher APIs
+const ValidFetchMethods = [
+  'GET',
+  'PATCH',
+  'POST',
+  'PUT',
+  'DELETE',
+] as const;
+export type FetchMethodType = typeof ValidFetchMethods[number];
 
 // Copied from https://developer.mozilla.org/en-US/docs/Web/API/Request
 export interface FetchRequest {
-  method: 'GET' | 'PATCH' | 'POST' | 'PUT' | 'DELETE';
+  method: FetchMethodType;
   url: string;
   body?: string;
   form?: {[key: string]: string};

diff --git a/dist/api_types.d.ts b/dist/api_types.d.ts
diff --git a/dist/api_types.js b/dist/api_types.js
diff --git a/dist/handler_templates.d.ts b/dist/handler_templates.d.ts
diff --git a/dist/index.d.ts b/dist/index.d.ts
diff --git a/handler_templates.ts b/handler_templates.ts
@@ -1,3 +1,4 @@
+import type {FetchMethodType} from './api_types';
 import type {FetchRequest} from './api_types';
 import type {FetchResponse} from './api_types';
 import type {ObjectSchemaProperty} from './schema';
@@ -17,7 +18,7 @@ type ParamMapper<T> = (val: T) => T;
 
 export interface RequestHandlerTemplate {
   url: string;
-  method: 'GET' | 'PATCH' | 'POST' | 'PUT' | 'DELETE';
+  method: FetchMethodType;
   headers?: {[header: string]: string};
   nameMapping?: {[functionParamName: string]: string};
   transforms?: {[name: string]: ParamMapper<any>};

diff --git a/index.ts b/index.ts
@@ -43,6 +43,7 @@ export type {DynamicSyncTableDef} from './api';
 export type {EmptyFormulaDef} from './api';
 export type {ExecutionContext} from './api_types';
 export type {Fetcher} from './api_types';
+export type {FetchMethodType} from './api_types';
 export type {FetchRequest} from './api_types';
 export type {FetchResponse} from './api_types';
 export type {GenericDynamicSyncTable} from './api';