You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
`filePath` | String | Any valid path or URL | **This is a required field** | This is the target the shortcut points to.
146
-
`outputPath` | String | Any valid path to a folder | `'%USERPROFILE%\\Desktop'` | Path where the shortcut will be placed.
146
+
`outputPath` | String | Any valid path to a folder | See description. | Path where the shortcut will be placed. The default value is determined by using PowerShell to ask Windows specifically where the User's desktop is located. If PowerShell is not available we default to `'%USERPROFILE%\\Desktop'`. This means it supports One Drive accounts, and other oddball setups, too.
147
147
`name` | String | Any file system safe string | Uses name from filePath | The name of the shortcut file.
148
148
`comment` | String | Any string | Not used if not supplied | Metadata file "comment" property. Description of what the shortcut would open.
149
149
`icon` | String | Valid path to file (ICO, EXE, or DLL) | Uses OS default icon | The image shown on the shortcut icon. You can also pass in an index if file contains multiple icons, like `'C:\\file.exe,0'`
@@ -257,6 +257,7 @@ Parts of the `windows.vbs` were copied/modified based on:
257
257
* Offer an async and sync mode, instead of just sync.
258
258
* Note: Make sure it can still run in older versions of NW.js
259
259
* Help with any of the known issues listed below:
260
+
* This repo is written using `require` for imports. I would endorse anyone that wants to create a fork of this repo written in ESM that drops support for older Node versions and is written with async support (maybe promises?). Maybe call it `create-desktop-shortcuts-esm` or something.
0 commit comments