Update docs for parsing

This commit is contained in:
Samuel Attard 2016-10-05 10:55:32 +11:00 committed by Zeke Sikelianos
parent b859afc118
commit 2b05c61ae3
8 changed files with 24 additions and 20 deletions

View file

@ -1,6 +1,6 @@
# Bounds # Bounds
* `x` Integer * `x` Number
* `y` Integer * `y` Number
* `width` Integer * `width` Number
* `height` Integer * `height` Number

View file

@ -4,6 +4,6 @@
* `issuerName` String - Issuer's Common Name * `issuerName` String - Issuer's Common Name
* `subjectName` String - Subject's Common Name * `subjectName` String - Subject's Common Name
* `serialNumber` String - Hex value represented string * `serialNumber` String - Hex value represented string
* `validStart` Integer - Start date of the certificate being valid in seconds * `validStart` Number - Start date of the certificate being valid in seconds
* `validExpiry` Integer - End date of the certificate being valid in seconds * `validExpiry` Number - End date of the certificate being valid in seconds
* `fingerprint` String - Fingerprint of the certificate * `fingerprint` String - Fingerprint of the certificate

View file

@ -1,14 +1,18 @@
# Display # Display
* `id` Integer - Unique identifier associated with the display. * `id` Number - Unique identifier associated with the display.
* `rotation` Integer - Can be 0, 90, 180, 270, represents screen rotation in * `rotation` Number - Can be 0, 90, 180, 270, represents screen rotation in
clock-wise degrees. clock-wise degrees.
* `scaleFactor` Number - Output device's pixel scale factor. * `scaleFactor` Number - Output device's pixel scale factor.
* `touchSupport` String - Can be `available`, `unavailable`, `unknown`. * `touchSupport` String - Can be `available`, `unavailable`, `unknown`.
* `bounds` Object * `bounds` [Bounds](bounds.md)
* `size` Object * `size` Object
* `workArea` Object * `height` Number
* `width` Number
* `workArea` [Bounds](bounds.md)
* `workAreaSize` Object * `workAreaSize` Object
* `height` Number
* `width` Number
The `Display` object represents a physical display connected to the system. A The `Display` object represents a physical display connected to the system. A
fake `Display` may exist on a headless system, or a `Display` may correspond to fake `Display` may exist on a headless system, or a `Display` may correspond to

View file

@ -22,7 +22,7 @@
Jump List, which can be an arbitrary resource file that contains an icon Jump List, which can be an arbitrary resource file that contains an icon
(e.g. `.ico`, `.exe`, `.dll`). You can usually specify `process.execPath` to (e.g. `.ico`, `.exe`, `.dll`). You can usually specify `process.execPath` to
show the program icon. show the program icon.
* `iconIndex` Integer - The index of the icon in the resource file. If a * `iconIndex` Number - The index of the icon in the resource file. If a
resource file contains multiple icons this value can be used to specify the resource file contains multiple icons this value can be used to specify the
zero-based index of the icon that should be displayed for this task. If a zero-based index of the icon that should be displayed for this task. If a
resource file contains only one icon, this property should be set to zero. resource file contains only one icon, this property should be set to zero.

View file

@ -1,8 +1,8 @@
# MemoryUsageDetails # MemoryUsageDetails
* `count` Integer * `count` Number
* `size` Integer * `size` Number
* `liveSize` Integer * `liveSize` Number
* `decodedSize` Integer * `decodedSize` Number
* `purgedSize` Integer * `purgedSize` Number
* `purgeableSize` Integer * `purgeableSize` Number

View file

@ -9,7 +9,7 @@ is empty.
* `icon` String (optional) - The path to the icon, can be a DLL or EXE. `icon` * `icon` String (optional) - The path to the icon, can be a DLL or EXE. `icon`
and `iconIndex` have to be set together. Default is empty, which uses the and `iconIndex` have to be set together. Default is empty, which uses the
target's icon. target's icon.
* `iconIndex` Integer (optional) - The resource ID of icon when `icon` is a * `iconIndex` Number (optional) - The resource ID of icon when `icon` is a
DLL or EXE. Default is 0. DLL or EXE. Default is 0.
* `appUserModelId` String (optional) - The Application User Model ID. Default * `appUserModelId` String (optional) - The Application User Model ID. Default
is empty. is empty.

View file

@ -9,6 +9,6 @@
* `iconPath` String - The absolute path to an icon to be displayed in a * `iconPath` String - The absolute path to an icon to be displayed in a
JumpList, which can be an arbitrary resource file that contains an icon. You JumpList, which can be an arbitrary resource file that contains an icon. You
can usually specify `process.execPath` to show the icon of the program. can usually specify `process.execPath` to show the icon of the program.
* `iconIndex` Integer - The icon index in the icon file. If an icon file * `iconIndex` Number - The icon index in the icon file. If an icon file
consists of two or more icons, set this value to identify the icon. If an consists of two or more icons, set this value to identify the icon. If an
icon file consists of one icon, this value is 0. icon file consists of one icon, this value is 0.

View file

@ -4,7 +4,7 @@
toolbar. toolbar.
* `click` Function * `click` Function
* `tooltip` String (optional) - The text of the button's tooltip. * `tooltip` String (optional) - The text of the button's tooltip.
* `flags` Array (optional) - Control specific states and behaviors of the * `flags` String[] (optional) - Control specific states and behaviors of the
button. By default, it is `['enabled']`. button. By default, it is `['enabled']`.
The `flags` is an array that can include following `String`s: The `flags` is an array that can include following `String`s: