@igor.dvlpr/open-resource

Open Resource

📂 Opens a given resource (URL, file, etc.) via the default OS handler. 🔎

💖 Support further development

I work hard for every project, including this one
and your support means a lot to me!

Consider buying me a coffee. ☕
Thank you for supporting my efforts! 🙏😊



@igorskyflyer

📃 Table of contents

• Features
• Usage
• API
  • IOptions
  • openSync()
  • open()
• Examples
• Changelog
• License
• Related
• Author

🤖 Features

• 💻 cross-platform, for Windows, macOS, Linux and Android using:
  • start/Start-Process for Windows
  • xdg-open for Linux (either native or bundled) and Android (alias of termux-open)
  • open for macOS
• ⏳ both sync and async methods
• 📃 supports passing of arguments

---

🕵🏼 Usage

Install it by executing:

npm i '@igor.dvlpr/open-resource'

---

🤹🏼 API

An options object can be passed to the open() functions, it being described by the interface IOptions as follows:

IOptions

interface IOptions {
  args?: string[]
  msShell?: 'cmd' | 'powershell'
}

args - The arguments to pass to the command.

msShell - The shell to use for the command execution. Only available on Windows.

---

openSync(resource: string, options?: IOptions): void

Opens a specified resource synchronously using the appropriate command for the current platform.

resource - The resource to be opened, a path, URL, etc. Must be a non-empty string.

options - Optional configuration for the command execution.

Throws an error if no resource is specified, if the arguments are invalid, or an error occurs during execution.

---

open(resource: string, options?: IOptions): Promise<void>

Opens a specified resource asynchronously using the appropriate command for the current platform.

resource - The resource to be opened, a path, URL, etc. Must be a non-empty string.

options - Optional configuration for the command execution.

Throws an error if no resource is specified, if the arguments are invalid, or an error occurs during execution.

---

✨ Examples

example.mts

import { openSync } from '@igor.dvlpr/open-resource'

openSync('https://igorskyflyer.me') // will open the default browser and navigate to the site

openSync('D:\\Data\\file.txt') // will open the text file in the default text viewer/editor

---

📝 Changelog

📑 The changelog is available here: CHANGELOG.md.

---

🪪 License

Licensed under the MIT license which is available here, MIT license.

---

🧬 Related

@igor.dvlpr/registry-apppaths

🪀 A Node.js module for reading the AppPaths registry key on Windows. Useful for retrieving applications that can be launched from the command prompt. 🗃

@igor.dvlpr/regkeys

📚 An npm package for fetching Windows registry keys. 🗝

@igor.dvlpr/upath

🎍 Provides a universal way of formatting file-paths in Unix-like and Windows operating systems as an alternative to the built-in path.normalize(). 🧬

@igor.dvlpr/windows-packages

💻 A Node.js module for reading the Packages registry key on Windows 10+. Useful for retrieving Windows 10+ installed Store applications. 📦

@igor.dvlpr/scrollend-polyfill

🛴 A performant and light (< 1.5KB) JavaScript polyfill for the scrollend Event. ⛸️

---

👨🏻‍💻 Author

Created by Igor Dimitrijević (@igorskyflyer).