Window Open Promise Reference

🪟 Promised Window.open();.

Usage

📦 Node

Install window-open-promise as a dependency:

pnpm add window-open-promise
# or
npm install window-open-promise
# or
yarn add window-open-promise

Import it and use it:

import { windowOpenPromise } from "window-open-promise";

const windowOpen = windowOpenPromise(globalThis);

windowOpen({
	url: "https://example.com", // URL is not required, you can open a blank window
	top: 10,
	left: 10,
})
	.then(newWindow => {
		newWindow.console.log("This will log in the new window.");
		newWindow.addEventListener("beforeunload", _event => {
			console.log("This will log when the new window is closed.");
		});
	})
	.catch(_error => {
		console.error("This will log if the new window can't be opened.");
	});

🦕 Deno

Import window-open-promise using the npm: prefix, and use it directly:

import { windowOpenPromise } from "npm:window-open-promise";

const windowOpen = windowOpenPromise(globalThis);

try {
	const newWindow = await windowOpen({
		url: "https://example.com", // URL is not required, you can open a blank window
		top: 10,
		left: 10,
	});
	newWindow.console.log("This will log in the new window.");
	newWindow.addEventListener("beforeunload", _event => {
		console.log("This will log when the new window is closed.");
	});
} catch (_error) {
	console.error("This will log if the new window can't be opened.");
}

🌎 Browser

Import window-open-promise using esm.sh, and use it directly:

<script type="module">
	import { windowOpenPromise } from "https://esm.sh/window-open-promise";

	const windowOpen = windowOpenPromise(globalThis);

	try {
		const newWindow = await windowOpen({
			url: "https://example.com", // URL is not required, you can open a blank window
			top: 10,
			left: 10,
		});
		newWindow.console.log("This will log in the new window.");
		newWindow.addEventListener("beforeunload", _event => {
			console.log("This will log when the new window is closed.");
		});
	} catch (_error) {
		console.error("This will log if the new window can't be opened.");
	}
</script>

Useful links

• 📝 Documentation: TypeDoc generated documentation.
• ⏳ Changelog: List of changes between versions.
• ✅ Tests Coverage: Coveralls page with tests coverage.

Type Aliases

WindowOpenPromiseFeatures

Ƭ WindowOpenPromiseFeatures: Omit<WindowOpenPromiseOptions, "replace" | "target" | "url">

WindowOpenPromise features.

---

WindowOpenPromiseOptions

Ƭ WindowOpenPromiseOptions: Object

WindowOpenPromise options.

Type declaration

Name	Type	Description
height (optional)	number	WindowOpenPromise height (minimum 100).
left (optional)	number	WindowOpenPromise left position.
menuBar (optional)	boolean	WindowOpenPromise renders the menu bar.
noOpener (optional)	boolean	WindowOpenPromise can’t access it’s opener.
resizable (optional)	boolean	WindowOpenPromise is resizable.
scrollbars (optional)	boolean	WindowOpenPromise has scrollbars.
target (optional)	string	WindowOpenPromise target.
titleBar (optional)	boolean	WindowOpenPromise renders the title bar.
toolBar (optional)	boolean	WindowOpenPromise renders the tool bar.
top (optional)	number	WindowOpenPromise top position.
url (optional)	string	WindowOpenPromise url.
width (optional)	number	WindowOpenPromise width (minimum 100).

Functions

featureJoin

▸ featureJoin<Item>(iterable): string

Joins given array of features with the FEATURE_SEPARATOR.

Type parameters

Name	Type
Item	extends Strigifiable

Parameters

Name	Type
iterable	Readonly<Iterable<Item>>

Returns

string

Joint string.

Example

featureJoin(["top=10", "left=10", "resizable=1"]); // "top=10,left=10,resizable=1"

---

featureMap

▸ featureMap(iterable): Readonly<IterableIterator<string>>

Maps array of feature entries to valid values.

Parameters

Name	Type
iterable	Readonly<Iterable<EntryOf<WindowOpenPromiseFeatures>>>

Returns

Readonly<IterableIterator<string>>

Array of formatted features.

Example

featureMap([
	["top", "10"],
	["left", "10"],
	["resizable", true],
]); // ["top=10", "left=10", "resizable=1"]

---

featureParser

▸ featureParser(features?): string

Parses features object into features string.

Parameters

Name	Type	Description
features (optional)	WindowOpenPromiseFeatures	Features object.

Returns

string

Parsed string.

Example

featureParser({
	top: 10,
	left: 10,
	resizable: true,
}); // "top=10,left=10,resizable=1"

---

featureValueMapper

▸ featureValueMapper(value): number

Takes a feature value and returns a formatted feature value.

Parameters

Name	Type
value	unknown

Returns

number

Feature value.

Example

featureValueMapper(true); // 1
featureValueMapper(false); // 0
featureValueMapper(13); // 13

---

windowOpenPromise

▸ windowOpenPromise(global): (options: WindowOpenPromiseOptions) => { catch: <RejectedValue_1>(this: void, onrejected?: Unary<unknown, RejectedValue_1 | PromiseLike<RejectedValue_1>>) => Promise<Window | RejectedValue_1> ; then: <ResolvedValue, RejectedValue>(this: void, onResolved?: Unary<Window, ResolvedValue | PromiseLike<ResolvedValue>>, onRejected?: Unary<unknown, RejectedValue | PromiseLike<RejectedValue>>) => Promise<ResolvedValue | RejectedValue> }

Promised Window.open.

Parameters

Name	Type
global	Readonly<Pick<Window, "open">>

Returns

fn

Curried function with window in context.

▸ (options?): Object

Curried function with window set.

Parameters

Name	Type	Default value	Description
options	WindowOpenPromiseOptions	EMPTY_OBJECT	WindowOpenPromise options.

Returns

Object

Promise with new window.

Name	Type	Description
catch	<RejectedValue_1>(this: void, onrejected?: Unary<unknown, RejectedValue_1 | PromiseLike<RejectedValue_1>>) => Promise<Window | RejectedValue_1>	-
then	<ResolvedValue, RejectedValue>(this: void, onResolved?: Unary<Window, ResolvedValue | PromiseLike<ResolvedValue>>, onRejected?: Unary<unknown, RejectedValue | PromiseLike<RejectedValue>>) => Promise<ResolvedValue | RejectedValue>	-

Example

const windowOpen = windowOpenPromise(window);
windowOpen({
	url: "https://example.com",
	top: 10,
	left: 10,
})
	.then(newWindow => {
		newWindow.console.log("This will log in the new window.");
		newWindow.addEventListener("beforeunload", _event => {
			console.log("This will log when the new window is closed.");
		});
	})
	.catch(_error => {
		console.error("This will log if the new window can't be opened.");
	});

Example

const windowOpen = windowOpenPromise(window);
windowOpen({
	url: "https://example.com",
	top: 10,
	left: 10,
})
	.then(newWindow => {
		newWindow.console.log("This will log in the new window.");
		newWindow.addEventListener("beforeunload", _event => {
			console.log("This will log when the new window is closed.");
		});
	})
	.catch(_error => {
		console.error("This will log if the new window can't be opened.");
	});