xhr-mocklet - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

.vscode/settings.json

@@ -12,3 +12,4 @@ {
   "sync.quietSync": false,
-  "sync.askGistName": false
-}
+  "sync.askGistName": false,
+  "editor.formatOnSave": false
+}

CHANGELOG.md

 # Changelog
 
+## 1.2.1
+
+- Clean up types and allow erroring the response similar to `xhr-mock`. Brought to you by [@joscha](https://github.com/joscha)
+
 ## 1.2.0
 
-- Add support for `MockXMLHttpRequestUpload`. Thanks a lot to @joscha !
+- Add support for `MockXMLHttpRequestUpload`. Thanks a lot to [@joscha](https://github.com/joscha) !
 
@@ -7,0 +11,0 @@ ## 1.1.0

lib/cjs/Builder.d.ts

 import MockXMLHttpRequest from "./MockXMLHttpRequest";
 import MockRequest from "./MockRequest";
 import MockResponse from "./MockResponse";
-export declare type MockCallback = (req?: MockRequest, res?: MockResponse) => MockResponse;
+export declare type UrlMatcher = string | RegExp;
+export declare type MockCallback = (req?: MockRequest, res?: MockResponse) => MockResponse | null;
 export declare class Builder {
     XMLHttpRequest: MockXMLHttpRequest;
     /** Replace the native XHR with the mocked XHR */
-    setup(): Builder;
+    setup(): this;
     /** Replace the mocked XHR with the native XHR and remove any handlers */
-    teardown(): Builder;
+    teardown(): this;
     /** Remove any handlers */
-    reset(): Builder;
+    reset(): this;
     /** Mock a requests */
-    mock(fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
-    mock(method: string, url?: string | RegExp, fn?: MockCallback): Builder;
+    mock(fn: MockCallback): this;
+    mock(method: string, url: UrlMatcher, fn: MockCallback): this;
     /** Mock a GET request */
-    get(url: string | RegExp, fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
+    get(url: UrlMatcher, fn: MockCallback): this;
     /** Mock a POST request */
-    post(url: string | RegExp, fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
+    post(url: UrlMatcher, fn: MockCallback): this;
     /** Mock a PUT request */
-    put(url: string | RegExp, fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
+    put(url: UrlMatcher, fn: MockCallback): this;
     /** Mock a PATCH request */
-    patch(url: string | RegExp, fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
+    patch(url: UrlMatcher, fn: MockCallback): this;
     /** Mock a DELETE request */
-    delete(url: string | RegExp, fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
+    delete(url: UrlMatcher, fn: MockCallback): this;
 }
 declare const _default: Builder;
 export default _default;

lib/cjs/Builder.js

@@ -43,8 +43,11 @@ "use strict";
                 }
-                return false;
+                return res;
             };
         }
-        else {
+        else if (typeof method === "function") {
             handler = method;
         }
+        else {
+            handler = (req, res) => res;
+        }
         MockXMLHttpRequest_1.default.addHandler(handler);
@@ -51,0 +54,0 @@ return this;

lib/cjs/index.d.ts

@@ -5,2 +5,3 @@ export { default as MockXMLHttpRequest } from "./MockXMLHttpRequest";
 export { default as MockRequest } from "./MockRequest";
+export { MockCallback, UrlMatcher } from "./Builder";
 export { default as default } from "./Builder";

lib/cjs/MockXMLHttpRequest.d.ts

@@ -0,1 +1,2 @@
+import { MockCallback } from "./Builder";
 import MockResponse from "./MockResponse";
@@ -9,7 +10,7 @@ import MockRequest from "./MockRequest";
     static readonly DONE: number;
-    static handlers: any[];
+    static handlers: MockCallback[];
     /** Add a request handler */
-    static addHandler(fn: (req: MockRequest, res: MockResponse) => any): void;
+    static addHandler(fn: MockCallback): void;
     /** Remove a request handler */
-    static removeHandler(fn: (req: MockRequest, res: MockRequest) => any): MockXMLHttpRequest;
+    static removeHandler(fn: MockCallback): MockXMLHttpRequest;
     /** Remove all request handlers */
@@ -19,3 +20,3 @@ static reset(): void;
     static handle(req: MockRequest): MockResponse | null;
-    readonly handlers: any[];
+    readonly handlers: MockCallback[];
     readonly UNSENT: number;
@@ -22,0 +23,0 @@ readonly OPENED: number;

lib/es/Builder.d.ts

 import MockXMLHttpRequest from "./MockXMLHttpRequest";
 import MockRequest from "./MockRequest";
 import MockResponse from "./MockResponse";
-export declare type MockCallback = (req?: MockRequest, res?: MockResponse) => MockResponse;
+export declare type UrlMatcher = string | RegExp;
+export declare type MockCallback = (req?: MockRequest, res?: MockResponse) => MockResponse | null;
 export declare class Builder {
     XMLHttpRequest: MockXMLHttpRequest;
     /** Replace the native XHR with the mocked XHR */
-    setup(): Builder;
+    setup(): this;
     /** Replace the mocked XHR with the native XHR and remove any handlers */
-    teardown(): Builder;
+    teardown(): this;
     /** Remove any handlers */
-    reset(): Builder;
+    reset(): this;
     /** Mock a requests */
-    mock(fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
-    mock(method: string, url?: string | RegExp, fn?: MockCallback): Builder;
+    mock(fn: MockCallback): this;
+    mock(method: string, url: UrlMatcher, fn: MockCallback): this;
     /** Mock a GET request */
-    get(url: string | RegExp, fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
+    get(url: UrlMatcher, fn: MockCallback): this;
     /** Mock a POST request */
-    post(url: string | RegExp, fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
+    post(url: UrlMatcher, fn: MockCallback): this;
     /** Mock a PUT request */
-    put(url: string | RegExp, fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
+    put(url: UrlMatcher, fn: MockCallback): this;
     /** Mock a PATCH request */
-    patch(url: string | RegExp, fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
+    patch(url: UrlMatcher, fn: MockCallback): this;
     /** Mock a DELETE request */
-    delete(url: string | RegExp, fn: (req?: MockRequest, res?: MockResponse) => MockResponse): Builder;
+    delete(url: UrlMatcher, fn: MockCallback): this;
 }
 declare const _default: Builder;
 export default _default;

lib/es/Builder.js

@@ -41,8 +41,11 @@ import MockXMLHttpRequest from "./MockXMLHttpRequest";
                 }
-                return false;
+                return res;
             };
         }
-        else {
+        else if (typeof method === "function") {
             handler = method;
         }
+        else {
+            handler = (req, res) => res;
+        }
         MockXMLHttpRequest.addHandler(handler);
@@ -49,0 +52,0 @@ return this;

lib/es/index.d.ts

@@ -5,2 +5,3 @@ export { default as MockXMLHttpRequest } from "./MockXMLHttpRequest";
 export { default as MockRequest } from "./MockRequest";
+export { MockCallback, UrlMatcher } from "./Builder";
 export { default as default } from "./Builder";

lib/es/MockXMLHttpRequest.d.ts

@@ -0,1 +1,2 @@
+import { MockCallback } from "./Builder";
 import MockResponse from "./MockResponse";
@@ -9,7 +10,7 @@ import MockRequest from "./MockRequest";
     static readonly DONE: number;
-    static handlers: any[];
+    static handlers: MockCallback[];
     /** Add a request handler */
-    static addHandler(fn: (req: MockRequest, res: MockResponse) => any): void;
+    static addHandler(fn: MockCallback): void;
     /** Remove a request handler */
-    static removeHandler(fn: (req: MockRequest, res: MockRequest) => any): MockXMLHttpRequest;
+    static removeHandler(fn: MockCallback): MockXMLHttpRequest;
     /** Remove all request handlers */
@@ -19,3 +20,3 @@ static reset(): void;
     static handle(req: MockRequest): MockResponse | null;
-    readonly handlers: any[];
+    readonly handlers: MockCallback[];
     readonly UNSENT: number;
@@ -22,0 +23,0 @@ readonly OPENED: number;

package.json

 {
   "name": "xhr-mocklet",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "main": "lib/cjs/index.js",
@@ -5,0 +5,0 @@ "module": "lib/es/index.js",

README.md

@@ -84,7 +84,7 @@ # XMLHttpRequest mocking
 | `reset()` | Remove all request handlers. |
-| `get(url: string | regex, callback)` | Create `GET` mock response for a specific url. |
-| `post(url: string | regex, callback)` | Create `POST` mock response for a specific url. |
-| `put(url: string | regex, callback)` | Create `PUT` mock response for a specific url. |
-| `patch(url: string | regex, callback)` | Create `PATCH` mock response for a specific url. |
-| `delete(url: string | regex, callback)` | Create `DELETE` mock response for a specific url. |
+| `get(url: string \| regex, callback)` | Create `GET` mock response for a specific url. |
+| `post(url: string \| regex, callback)` | Create `POST` mock response for a specific url. |
+| `put(url: string \| regex, callback)` | Create `PUT` mock response for a specific url. |
+| `patch(url: string \| regex, callback)` | Create `PATCH` mock response for a specific url. |
+| `delete(url: string \| regex, callback)` | Create `DELETE` mock response for a specific url. |
 | `mock(callback)` | Register mock response for every request. |
@@ -119,4 +119,4 @@
 | `body(body: string)` | Set response body. |
-| `timeout(): boolean | number` | Get weather the response will trigger a timeout. |
-| `timeout(ms: boolean | number)` | Set a timeout, otherwise default to the value set on the XHR object. |
+| `timeout(): boolean \| number` | Get weather the response will trigger a timeout. |
+| `timeout(ms: boolean \| number)` | Set a timeout, otherwise default to the value set on the XHR object. |
 | `progress(loaded: number, total: number, lengthComputable: boolean)` | Trigger progress event. Pass in loaded size, total size and if event is lengthComputable. |
@@ -123,0 +123,0 @@

No alert changes

Improved metrics

Total package byte prevSize

137191

increased by0.16%

Lines of code

1386

increased by1.02%

No dependency changes