docs: shell.writeShortcutLink/readShortcutLink

zcbenz · zcbenz · commit d6234e11dfc6 · 2016-07-27T16:47:24.000+09:00
diff --git a/docs/api/shell.md b/docs/api/shell.md
@@ -48,3 +48,36 @@ Move the given file to trash and returns a boolean status for the operation.
 ### `shell.beep()`
 
 Play the beep sound.
+
+### `shell.writeShortcutLink(shortcutPath[, operation], options)` _Windows_
+
+* `shortcutPath` String
+* `operation` String (optional) - Default is `create`, can be one of followings:
+  * `create` - Creates a new shortcut, overwriting if necessary.
+  * `update` - Updates specified properties only on an existing shortcut.
+  * `replace` - Overwrites an existing shortcut, fails if the shortcut doesn't
+    exist.
+* `options` Object
+  * `target` String - The target to launch from this shortcut.
+  * `cwd` String (optional) - The target to launch from this shortcut. Default
+    is empty.
+  * `args` String (optional) - The arguments to be applied to `target` when
+    launching from this shortcut. Default is empty.
+  * `description` String (optional) - The description of the shortcut. Default
+    is empty.
+  * `icon` String (optional) - The path to the icon, can be a DLL or EXE.
+    Default is empty, which uses the target's icon.
+  * `iconIndex` Integer (optional) - The resource ID of icon when `icon` is a
+    DLL or EXE. Default is 0.
+  * `appUserModelId` String (optional) - The Application User Model ID. Default
+    is empty.
+
+Creates or updates a shortcut link at `shortcutPath`. On success `true` is
+returned, otherwise `false` is returned.
+
+### `shell.readShortcutLink(shortcutPath)` _Windows_
+
+Resolves the shortcut link at `shortcutPath`, an object is returned with the
+fields described in the `options` of `shell.writeShortcutLink`.
+
+An exception will be thrown when any error happens.
