@thangved/callback-window 1.1.0 → 1.1.1

package/README.md

@@ -0,0 +1,44 @@
+# Callback window
+
+> A simple handler for external website window callback
+
+## Install
+
+Install this package via npm
+
+```sh
+npm i @thangved/callback-window
+```
+
+Or via yarn
+
+```sh
+yarn add @thangved/callback-window
+```
+
+## Usage
+
+```ts
+import { startCallbackWindow } from '@thangved/callback-window';
+
+const handleCallback = async () => {
+  try {
+    const { redirectedUrl } = await startCallbackWindow(
+      'https://redirect.thangved.com/?redirect_uri=https://profile.thangved.com',
+    );
+
+    console.log(redirectedUrl); // https://profile.thangved.com
+  } catch (error) {
+    console.log(error);
+  }
+};
+```
+
+## Options
+
+| Option                | Type                                                  | Default    | Description                                                                                                                                 |
+| --------------------- | ----------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| `timeout`             | `number`                                              | `Infinity` | Time to close window in milliseconds                                                                                                        |
+| `interval`            | `number`                                              | `100`      | Time to check current URL in milliseconds                                                                                                   |
+| `shouldClose`         | `(currentUrl: string) => boolean \| Promise<boolean>` | –          | The window checker should be closed. By default, the window will close when the origin of the window equals the origin of the parent window |
+| `onBrowserNotAllowed` | `(url: string) => void`                               | –          | What to do when the browser does not allow opening new windows; by default changes the current window address to the destination address    |

package/dist/cjs/index.d.cts

@@ -24,7 +24,7 @@ interface IStartCallbackWindowResult {
     redirectedUrl: string;
 }
 interface IStartCallbackWindow {
-    (url: string, options: Partial<IStartCallbackWindowOptions>): Promise<IStartCallbackWindowResult>;
+    (url: string, options?: Partial<IStartCallbackWindowOptions>): Promise<IStartCallbackWindowResult>;
 }
 
 declare const startCallbackWindow: IStartCallbackWindow;

package/dist/esm/index.d.ts

@@ -24,7 +24,7 @@ interface IStartCallbackWindowResult {
     redirectedUrl: string;
 }
 interface IStartCallbackWindow {
-    (url: string, options: Partial<IStartCallbackWindowOptions>): Promise<IStartCallbackWindowResult>;
+    (url: string, options?: Partial<IStartCallbackWindowOptions>): Promise<IStartCallbackWindowResult>;
 }
 
 declare const startCallbackWindow: IStartCallbackWindow;

package/package.json

@@ -28,7 +28,7 @@
   "files": [
     "dist"
   ],
-  "homepage": "https://github.com/thangved/callback-window#readme",
+  "homepage": "https://github.com/thangved/callback-window/packages/callback-window#readme",
   "keywords": [
     "js"
   ],
@@ -52,5 +52,5 @@
   "sideEffects": false,
   "type": "module",
   "types": "./dist/esm/index.d.ts",
-  "version": "1.1.0"
+  "version": "1.1.1"
 }