@deeptrekker/api-channels 0.7.1 → 0.8.0
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/dist/index.es.js +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/lib/signalR/index.d.ts +1 -0
- package/dist/types/index.d.ts +4 -6
- package/package.json +1 -1
package/dist/types/index.d.ts
CHANGED
|
@@ -38,15 +38,15 @@ export type SessionInfo = {
|
|
|
38
38
|
/**
|
|
39
39
|
* Connection State
|
|
40
40
|
*
|
|
41
|
-
* Used to describe the current state of the connection process
|
|
41
|
+
* Used to describe the current state of the Bridge Box connection process
|
|
42
42
|
* @readonly
|
|
43
43
|
* @enum
|
|
44
44
|
* @member Searching - The connection process has not started yet
|
|
45
45
|
* @member Connecting - Attempting to connect to the signaling server
|
|
46
|
-
* @member Connected - The connection has been established and WebRTC is being initialized
|
|
46
|
+
* @member Connected - The connection to Bridge Box has been established and WebRTC is being initialized to connect to the vehicle.
|
|
47
47
|
* @member Error - An error occurred when during the connection process
|
|
48
48
|
* @member SSL - The system detected a potential SSL validation error.
|
|
49
|
-
* @member Ready - The connection is successful and both systems are able to communicate.
|
|
49
|
+
* @member Ready - The connection to the vehicle is successful and both systems (client app & the vehicle) are able to communicate.
|
|
50
50
|
*/
|
|
51
51
|
export declare enum ConnectionState {
|
|
52
52
|
Searching = 0,
|
|
@@ -64,8 +64,7 @@ export declare enum ConnectionState {
|
|
|
64
64
|
* @property {string} ip: The desired ip address to connect to. If none are provided uses the [default ip address]({@link SIGNAL_SERVER_CONNECTION_STRING})
|
|
65
65
|
* @property {boolean} reconnection: Indicates that the initial connection failed and now the system is attempting to connect again
|
|
66
66
|
* @property {boolean} isElectron: Indicates whether or not the library is being used in an Electron application. Prevents certain states from being reached if it is.
|
|
67
|
-
* @property {callback} onConnectionStateChange:
|
|
68
|
-
* @property {callback} onDeviceError:
|
|
67
|
+
* @property {callback} onConnectionStateChange: Handler for the connectionState of Bridge Box.
|
|
69
68
|
*/
|
|
70
69
|
export interface ConnectionSettings {
|
|
71
70
|
ip?: string;
|
|
@@ -73,7 +72,6 @@ export interface ConnectionSettings {
|
|
|
73
72
|
isElectron?: boolean;
|
|
74
73
|
connectionState?: ConnectionState;
|
|
75
74
|
onConnectionStateChange?: (newState: ConnectionState) => void;
|
|
76
|
-
onDeviceError?: (deviceError: boolean) => void;
|
|
77
75
|
onSocketConnected?: (socket: HubConnection) => void;
|
|
78
76
|
}
|
|
79
77
|
/**
|