X Tutup
Skip to content

Commit 0696070

Browse files
Update docs for dts again
1 parent b036fdf commit 0696070

File tree

12 files changed

+53
-33
lines changed

12 files changed

+53
-33
lines changed

docs/api/app.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Returns:
113113
* `url` String
114114

115115
Emitted when the user wants to open a URL with the application. Your application's
116-
`Info.plist` file must define the url scheme within the `CFBundleURLTypes` key, and
116+
`Info.plist` file must define the url scheme within the `CFBundleURLTypes` key, and
117117
set `NSPrincipalClass` to `AtomApplication`.
118118

119119
You should call `event.preventDefault()` if you want to handle this event.
@@ -189,7 +189,7 @@ Returns:
189189

190190
* `event` Event
191191
* `webContents` [WebContents](web-contents.md)
192-
* `url` URL
192+
* `url` String
193193
* `error` String - The error code
194194
* `certificate` [Certificate](structures/certificate.md)
195195
* `callback` Function
@@ -891,7 +891,7 @@ Sets the application's [dock menu][dock-menu].
891891

892892
### `app.dock.setIcon(image)` _macOS_
893893

894-
* `image` [NativeImage](native-image.md)
894+
* `image` ([NativeImage](native-image.md) | String)
895895

896896
Sets the `image` associated with this dock icon.
897897

docs/api/browser-window.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
202202
* `thickFrame` Boolean (optional) - Use `WS_THICKFRAME` style for frameless windows on
203203
Windows, which adds standard window frame. Setting it to `false` will remove
204204
window shadow and window animations. Default is `true`.
205-
* `vibrancy` String - Add a type of vibrancy effect to the window, only on
205+
* `vibrancy` String - (optional) Add a type of vibrancy effect to the window, only on
206206
macOS. Can be `appearance-based`, `light`, `dark`, `titlebar`, `selection`,
207207
`menu`, `popover`, `sidebar`, `medium-light` or `ultra-dark`.
208208
* `zoomToPageWidth` Boolean - Controls the behavior on macOS when

docs/api/incoming-message.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,11 @@ A String indicating the HTTP protocol version number. Typical values are '1.0'
6464
or '1.1'. Additionally `httpVersionMajor` and `httpVersionMinor` are two
6565
Integer-valued readable properties that return respectively the HTTP major and
6666
minor version numbers.
67+
68+
#### `response.httpVersionMajor`
69+
70+
An Integer indicating the HTTP protocol major version number.
71+
72+
#### `response.httpVersionMinor`
73+
74+
An Integer indicating the HTTP protocol minor version number.

docs/api/menu-item.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,11 @@ A `radio` menu item will turn on its `checked` property when clicked, and
106106
will turn off that property for all adjacent items in the same menu.
107107

108108
You can add a `click` function for additional behavior.
109+
110+
#### `menuItem.label`
111+
112+
A String representing the menu items visible label
113+
114+
#### `menuItem.click`
115+
116+
A Function that is fired when the MenuItem recieves a click event

docs/api/protocol.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ treated as a standard scheme.
118118
* `method` String
119119
* `uploadData` [UploadData[]](structures/upload-data.md)
120120
* `callback` Function
121-
* `buffer` Buffer (optional)
121+
* `buffer` (Buffer | [MimeTypedBuffer](structures/mime-typed-buffer.md)) (optional)
122122
* `completion` Function (optional)
123123
* `error` Error
124124

docs/api/session.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ The `proxyBypassRules` is a comma separated list of rules described below:
200200
Match local addresses. The meaning of `<local>` is whether the
201201
host matches one of: "127.0.0.1", "::1", "localhost".
202202

203-
### `ses.resolveProxy(url, callback)`
203+
#### `ses.resolveProxy(url, callback)`
204204

205205
* `url` URL
206206
* `callback` Function

docs/api/structures/cookie.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
* `name` String - The name of the cookie.
44
* `value` String - The value of the cookie.
5-
* `domain` String - The domain of the cookie.
6-
* `hostOnly` String - Whether the cookie is a host-only cookie.
7-
* `path` String - The path of the cookie.
8-
* `secure` Boolean - Whether the cookie is marked as secure.
9-
* `httpOnly` Boolean - Whether the cookie is marked as HTTP only.
10-
* `session` Boolean - Whether the cookie is a session cookie or a persistent
5+
* `domain` String - (optional) The domain of the cookie.
6+
* `hostOnly` Boolean - (optional) Whether the cookie is a host-only cookie.
7+
* `path` String - (optional) The path of the cookie.
8+
* `secure` Boolean - (optional) Whether the cookie is marked as secure.
9+
* `httpOnly` Boolean - (optional) Whether the cookie is marked as HTTP only.
10+
* `session` Boolean - (optional) Whether the cookie is a session cookie or a persistent
1111
cookie with an expiration date.
12-
* `expirationDate` Double (optional) - The expiration date of the cookie as
12+
* `expirationDate` Double - (optional) The expiration date of the cookie as
1313
the number of seconds since the UNIX epoch. Not provided for session
1414
cookies.

docs/api/structures/jump-list-category.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# JumpListCategory Object
22

3-
* `type` String - One of the following:
3+
* `type` String - (optional) One of the following:
44
* `tasks` - Items in this category will be placed into the standard `Tasks`
55
category. There can be only one such category, and it will always be
66
displayed at the bottom of the Jump List.

docs/api/structures/jump-list-item.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# JumpListItem Object
22

3-
* `type` String - One of the following:
3+
* `type` String - (optional) One of the following:
44
* `task` - A task will launch an app with specific arguments.
55
* `separator` - Can be used to separate items in the standard `Tasks`
66
category.
@@ -18,11 +18,11 @@
1818
Should only be set if `type` is `task`.
1919
* `description` String - (optional) Description of the task (displayed in a tooltip).
2020
Should only be set if `type` is `task`.
21-
* `iconPath` String - The absolute path to an icon to be displayed in a
21+
* `iconPath` String - (optional) The absolute path to an icon to be displayed in a
2222
Jump List, which can be an arbitrary resource file that contains an icon
2323
(e.g. `.ico`, `.exe`, `.dll`). You can usually specify `process.execPath` to
2424
show the program icon.
25-
* `iconIndex` Number - The index of the icon in the resource file. If a
25+
* `iconIndex` Number - (optional) The index of the icon in the resource file. If a
2626
resource file contains multiple icons this value can be used to specify the
2727
zero-based index of the icon that should be displayed for this task. If a
2828
resource file contains only one icon, this property should be set to zero.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# MimeTypedBuffer Object
2+
3+
* `mimeType` String - The mimeType of the Buffer that you are sending
4+
* `buffer` Buffer - The actual Buffer content

0 commit comments

Comments
 (0)
X Tutup