add startsWith, endsWith and includes method

Author: jdeniau

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.1.0
+
+### Added
+
+- add `startsWith`, `endsWith` and `includes` helper methods.
+
 ## 1.0.0
 
-Initial version
+Initial version

README.md

@@ -68,6 +68,7 @@ describe('some test file', () => {
 
     fetchMock.get('https://match.get/test', expected);
     fetchMock.put(/https:\/\/match.put\//, expected);
+    fetchMock.post.startsWith('https://match.post/', expected);
 
     const r1 = await doFetchWithToken('https://match.get/test');
 
@@ -78,6 +79,12 @@ describe('some test file', () => {
     });
 
     expect(r2).toBe(expected);
+
+    const r3 = await doFetchWithToken('https://match.post/test', {
+      method: 'POST',
+    });
+
+    expect(r3).toBe(expected);
   });
 
   test('some test with a complex matcher', () => {
@@ -119,6 +126,11 @@ function fetchMock.post(url: string | RegExp, response: Response): void;
 function fetchMock.put(url: string | RegExp, response: Response): void;
 function fetchMock.patch(url: string | RegExp, response: Response): void;
 function fetchMock.delete(url: string | RegExp, response: Response): void;
+
+// foreach methods, there are string helper too
+function fetchMock.<httpVerb>.startsWith(url: string, response: Response): void;
+function fetchMock.<httpVerb>.endsWith(url: string, response: Response): void;
+function fetchMock.<httpVerb>.includes(url: string, response: Response): void;
 ```
 
 Utility functions:

src/fetchMock.test.ts

@@ -160,3 +160,39 @@ describe('fetchMock.method', () => {
     );
   });
 });
+
+describe('fetchMock.method.stringMethod', () => {
+  test('startsWith', async () => {
+    const response = new Response('Hello world !');
+
+    fetchMock.delete.startsWith('https://www.mapado.com', response);
+
+    const result = await fetch('https://www.mapado.com/foo.bar', {
+      method: 'DELETE',
+    });
+
+    expect(result).toBe(response);
+  });
+
+  test('endsWith', async () => {
+    const response = new Response('Hello world !');
+
+    fetchMock.patch.endsWith('foo.bar', response);
+
+    const result = await fetch('https://www.mapado.com/foo.bar', {
+      method: 'PATCH',
+    });
+
+    expect(result).toBe(response);
+  });
+
+  test('includes', async () => {
+    const response = new Response('Hello world !');
+
+    fetchMock.get.includes('mapado', response);
+
+    const result = await fetch('https://www.mapado.com/foo.bar');
+
+    expect(result).toBe(response);
+  });
+});

src/fetchMock.ts

@@ -21,13 +21,7 @@ export function resetMocks(): void {
   matchers = [];
 }
 
-function fetchMock(matcher: MatcherFunction, response: Response): void {
-  matchers.push(new Matcher(matcher, response));
-
-  overrideFetch();
-}
-
-function overrideFetch() {
+function overrideFetch(): void {
   globalThis.fetch = async (
     input: URL | RequestInfo,
     options: RequestInit | undefined,
@@ -46,11 +40,36 @@ function overrideFetch() {
   };
 }
 
+type FetchMockHelper = {
+  (url: string | RegExp, response: Response): void;
+  startsWith: FetchMockStringHelper;
+  endsWith: FetchMockStringHelper;
+  includes: FetchMockStringHelper;
+};
+type FetchMockStringHelper = (url: string, response: Response) => void;
+type ValidStringMethod = 'startsWith' | 'endsWith' | 'includes';
+
+type FetchMockFunction = {
+  (matcher: MatcherFunction, response: Response): void;
+  get: FetchMockHelper;
+  post: FetchMockHelper;
+  put: FetchMockHelper;
+  patch: FetchMockHelper;
+  delete: FetchMockHelper;
+};
+
+const fetchMock: FetchMockFunction = (matcher, response): void => {
+  matchers.push(new Matcher(matcher, response));
+
+  overrideFetch();
+};
+
 /**
- * Simple matcher for quick mocking
+ * Simple matcher for quick mocking.
+ * For example `fetchMock.post(url: string | RegExp, response: Response)` helper.
  */
 function generateFetchMockHelper(method: string): FetchMockHelper {
-  return (url: string | RegExp, response: Response) => {
+  const fn: FetchMockHelper = (url: string | RegExp, response: Response) => {
     return fetchMock((input, options) => {
       if (getOptionMethod(options) !== method) {
         return false;
@@ -69,28 +88,36 @@ function generateFetchMockHelper(method: string): FetchMockHelper {
       );
     }, response);
   };
-}
-
-type FetchMockHelper = (url: string | RegExp, response: Response) => void;
-
-const get: FetchMockHelper = (url, response): void =>
-  generateFetchMockHelper('GET')(url, response);
 
-const post: FetchMockHelper = (url, response): void =>
-  generateFetchMockHelper('POST')(url, response);
+  fn.startsWith = generateFetchMockStringHelper(method, 'startsWith');
+  fn.endsWith = generateFetchMockStringHelper(method, 'endsWith');
+  fn.includes = generateFetchMockStringHelper(method, 'includes');
 
-const put: FetchMockHelper = (url, response): void =>
-  generateFetchMockHelper('PUT')(url, response);
+  return fn;
+}
 
-const patch: FetchMockHelper = (url, response): void =>
-  generateFetchMockHelper('PATCH')(url, response);
+/**
+ * This function generate string helper functions.
+ * For example `fetchMock.post.startsWith(startUrl: string, response: Response)` helper.
+ */
+function generateFetchMockStringHelper(
+  method: string,
+  methodName: ValidStringMethod,
+): FetchMockStringHelper {
+  return (url, response) => {
+    return fetchMock(
+      (input, options) =>
+        getOptionMethod(options) === method &&
+        getInputUrl(input)[methodName](url),
+      response,
+    );
+  };
+}
 
-const deleteFn: FetchMockHelper = (url, response): void =>
-  generateFetchMockHelper('DELETE')(url, response);
-fetchMock.get = get;
-fetchMock.post = post;
-fetchMock.put = put;
-fetchMock.patch = patch;
-fetchMock.delete = deleteFn;
+fetchMock.get = generateFetchMockHelper('GET');
+fetchMock.post = generateFetchMockHelper('POST');
+fetchMock.put = generateFetchMockHelper('PUT');
+fetchMock.patch = generateFetchMockHelper('PATCH');
+fetchMock.delete = generateFetchMockHelper('DELETE');
 
 export default fetchMock;