@openfin/node-adapter 34.78.50 → 34.78.51
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -11
- package/out/node-adapter-alpha.d.ts +516 -367
- package/out/node-adapter-beta.d.ts +516 -367
- package/out/node-adapter-public.d.ts +516 -367
- package/out/node-adapter.d.ts +534 -462
- package/out/node-adapter.js +201 -37
- package/package.json +1 -1
package/README.md
CHANGED
@@ -1,8 +1,8 @@
|
|
1
1
|
# OpenFin Node.js adapter
|
2
2
|
|
3
|
-
Allows the use of the OpenFin API from node.js. Please note the launch and connect methods are specific to a node environment.
|
3
|
+
Allows the use of the OpenFin API from node.js. Please note that the `launch` and `connect` methods are specific to a node environment.
|
4
4
|
|
5
|
-
##
|
5
|
+
## Prerequisites
|
6
6
|
|
7
7
|
- Node.js 16 or greater
|
8
8
|
|
@@ -12,11 +12,11 @@ Allows the use of the OpenFin API from node.js. Please note the launch and conne
|
|
12
12
|
|
13
13
|
`connect` can be used to establish a connection to an OpenFin runtime from node.
|
14
14
|
|
15
|
-
A uuid must be provided to identify the connection. Multiple connections
|
15
|
+
A `uuid` value must be provided to identify the connection. Multiple connections require distinct `uuid` values.
|
16
16
|
|
17
|
-
A
|
17
|
+
A Runtime version or manifest URL must also be specified.
|
18
18
|
|
19
|
-
Note
|
19
|
+
> Note: `connect` instantiates a Runtime instance if one does not exist for the given configuration. If a Runtime is already running, `connect` simply establishes a new connection.
|
20
20
|
|
21
21
|
### Connecting via Runtime Version
|
22
22
|
|
@@ -34,7 +34,7 @@ import { connect } from '@openfin/node-adapter';
|
|
34
34
|
})();
|
35
35
|
```
|
36
36
|
|
37
|
-
### Connecting via Manifest
|
37
|
+
### Connecting via Manifest URL
|
38
38
|
|
39
39
|
```javascript
|
40
40
|
import { connect } from '@openfin/node-adapter';
|
@@ -53,9 +53,9 @@ import { connect } from '@openfin/node-adapter';
|
|
53
53
|
|
54
54
|
Unlike `connect`, `launch` starts an OpenFin application if not running and returns a port number instead of a `fin` object.
|
55
55
|
|
56
|
-
This can be provided to connect to create a `fin` object for the
|
56
|
+
This port number can be provided to connect to create a `fin` object for the Runtime that has been created on the specific port.
|
57
57
|
|
58
|
-
`launch` can be called multiple times for a given application
|
58
|
+
`launch` can be called multiple times for a given application; however launches for an application that is already running result in a [run-requested](https://developer.openfin.co/jsdocs/stable/tutorial-application.addEventListener.html#run-requested) event being triggered instead of a relaunch. If the application is an OpenFin platform, this scenario results in the layout windows reloading.
|
59
59
|
|
60
60
|
### Launching and Connecting via Port
|
61
61
|
|
@@ -80,9 +80,9 @@ import { launch, connect } from '@openfin/node-adapter';
|
|
80
80
|
|
81
81
|
## Types
|
82
82
|
|
83
|
-
`@openfin/node-adapter` comes bundled with its own types
|
83
|
+
`@openfin/node-adapter` comes bundled with its own types.
|
84
84
|
|
85
|
-
If you wish to explicitly reference OpenFin types, the `OpenFin` namespace export
|
85
|
+
If you wish to explicitly reference OpenFin types, the `OpenFin` namespace export can be used as follows:
|
86
86
|
|
87
87
|
### Type Usage Example
|
88
88
|
|
@@ -105,7 +105,7 @@ import OpenFin, { connect } from '@openfin/node-adapter';
|
|
105
105
|
|
106
106
|
For users of the `connect` and `launch` functions in `openfin-adapter`, no changes are necessary, other than updating the dependency name.
|
107
107
|
|
108
|
-
If using the exported types from `openfin-adapter`,
|
108
|
+
If you are using the exported types from `openfin-adapter`, you can now use the `OpenFin` export that encapsualates them.
|
109
109
|
|
110
110
|
### Before
|
111
111
|
|