Skip to content

Commit 76277e0

Browse files
committed
doc(api/README.md): update api docs
1 parent 5d2f1e3 commit 76277e0

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

api/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -142,15 +142,15 @@ Returns the ApplicationWindow instance for the given index
142142
| :--- | :--- | :--- |
143143
| Not specified | Promise<ApplicationWindow> | the ApplicationWindow instance or null if the window does not exist |
144144

145-
## [`getCurrentWindow()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L472)
145+
## [`getCurrentWindow()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L474)
146146

147147
Returns the ApplicationWindow instance for the current window.
148148

149149
| Return Value | Type | Description |
150150
| :--- | :--- | :--- |
151151
| Not specified | Promise<ApplicationWindow> | |
152152

153-
## [`exit(code)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L481)
153+
## [`exit(code)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L483)
154154

155155
Quits the backend process and then quits the render process, the exit code used is the final exit code to the OS.
156156

@@ -162,7 +162,7 @@ Quits the backend process and then quits the render process, the exit code used
162162
| :--- | :--- | :--- |
163163
| Not specified | Promise<ipc.Result> | |
164164

165-
## [`setSystemMenu(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L578)
165+
## [`setSystemMenu(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L580)
166166

167167
Set the native menu for the app.
168168

@@ -257,11 +257,11 @@ Set the native menu for the app.
257257
| :--- | :--- | :--- |
258258
| Not specified | Promise<ipc.Result> | |
259259
260-
## [`setTrayMenu()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L585)
260+
## [`setTrayMenu()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L587)
261261
262262
An alias to setSystemMenu for creating a tary menu
263263
264-
## [`setSystemMenuItemEnabled(value)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L594)
264+
## [`setSystemMenuItemEnabled(value)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L596)
265265
266266
Set the enabled state of the system menu.
267267
@@ -273,31 +273,31 @@ Set the enabled state of the system menu.
273273
| :--- | :--- | :--- |
274274
| Not specified | Promise<ipc.Result> | |
275275
276-
## [`isPaused()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L602)
276+
## [`isPaused()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L604)
277277
278278
Predicate function to determine if application is in a "paused" state.
279279
280280
| Return Value | Type | Description |
281281
| :--- | :--- | :--- |
282282
| Not specified | boolean | |
283283
284-
## [runtimeVersion](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L610)
284+
## [runtimeVersion](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L612)
285285
286286
Socket Runtime version.
287287
288-
## [debug](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L616)
288+
## [debug](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L618)
289289
290290
Runtime debug flag.
291291
292-
## [config](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L622)
292+
## [config](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L624)
293293
294294
Application configuration.
295295
296-
## [backend](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L627)
296+
## [backend](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L629)
297297
298298
The application's backend instance.
299299
300-
### [`open(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L633)
300+
### [`open(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L635)
301301
302302
303303
@@ -310,7 +310,7 @@ The application's backend instance.
310310
| :--- | :--- | :--- |
311311
| Not specified | Promise<ipc.Result> | |
312312
313-
### [`close()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L641)
313+
### [`close()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L643)
314314
315315
316316

0 commit comments

Comments
 (0)