emr-bridge 1.7.1 → 2.0.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/LICENCE +1 -1
- package/README.md +173 -366
- package/cjs/entries/index.d.ts +1 -0
- package/cjs/entries/index.js +6 -0
- package/cjs/entries/main.d.ts +2 -0
- package/cjs/entries/main.js +27 -0
- package/cjs/entries/preload.d.ts +3 -0
- package/cjs/entries/preload.js +29 -0
- package/cjs/entries/renderer.d.ts +2 -0
- package/cjs/entries/renderer.js +27 -0
- package/cjs/enums.d.ts +5 -14
- package/cjs/enums.js +12 -23
- package/cjs/errors.d.ts +42 -10
- package/cjs/errors.js +77 -23
- package/cjs/index.d.ts +4 -4
- package/cjs/index.js +11 -13
- package/cjs/main.d.ts +2 -4
- package/cjs/main.js +4 -13
- package/cjs/preload.d.ts +2 -2
- package/cjs/preload.js +3 -3
- package/cjs/renderer.d.ts +1 -1
- package/cjs/scripts/base-bridge.d.ts +95 -0
- package/cjs/scripts/base-bridge.js +128 -0
- package/cjs/scripts/bridge.d.ts +3 -3
- package/cjs/scripts/bridge.js +48 -36
- package/cjs/scripts/helpers/env.d.ts +19 -0
- package/cjs/scripts/helpers/env.js +28 -0
- package/cjs/scripts/helpers/error-thrower.d.ts +3 -0
- package/cjs/scripts/helpers/error-thrower.js +8 -0
- package/cjs/scripts/helpers/errors.d.ts +12 -0
- package/cjs/scripts/helpers/errors.js +17 -0
- package/cjs/scripts/helpers/id.d.ts +9 -0
- package/cjs/scripts/helpers/id.js +14 -0
- package/cjs/scripts/helpers/index.d.ts +8 -0
- package/cjs/scripts/helpers/index.js +22 -0
- package/cjs/scripts/helpers/ipc-channel.d.ts +75 -0
- package/cjs/scripts/helpers/ipc-channel.js +78 -0
- package/cjs/scripts/helpers/ipc-event-in-main.d.ts +24 -0
- package/cjs/scripts/helpers/ipc-event-in-main.js +30 -0
- package/cjs/scripts/helpers/ipc-result.d.ts +26 -0
- package/cjs/scripts/helpers/ipc-result.js +48 -0
- package/cjs/scripts/helpers/main-event.d.ts +8 -0
- package/cjs/scripts/helpers/main-event.js +15 -0
- package/cjs/scripts/helpers/transfer.d.ts +33 -0
- package/cjs/scripts/helpers/transfer.js +57 -0
- package/cjs/scripts/helpers/web-contents-container.d.ts +12 -0
- package/cjs/scripts/helpers/web-contents-container.js +34 -0
- package/cjs/scripts/helpers/web-contents-events-container.d.ts +56 -0
- package/cjs/scripts/helpers/web-contents-events-container.js +81 -0
- package/cjs/scripts/main/publish.d.ts +36 -0
- package/cjs/scripts/main/publish.js +186 -0
- package/cjs/scripts/preload/bridge.d.ts +27 -0
- package/cjs/scripts/preload/bridge.js +85 -0
- package/cjs/scripts/preload/provider.d.ts +7 -0
- package/cjs/scripts/preload/provider.js +89 -0
- package/cjs/scripts/preload-bridge.d.ts +20 -0
- package/cjs/scripts/preload-bridge.js +76 -0
- package/cjs/scripts/preload-provider.js +34 -50
- package/cjs/scripts/provider.d.ts +17 -15
- package/cjs/scripts/provider.js +69 -90
- package/cjs/scripts/publish.d.ts +19 -18
- package/cjs/scripts/publish.js +96 -174
- package/cjs/scripts/renderer/bridge.d.ts +6 -0
- package/cjs/scripts/renderer/bridge.js +74 -0
- package/cjs/scripts/renderer/tunnels.d.ts +171 -0
- package/cjs/scripts/renderer/tunnels.js +205 -0
- package/cjs/scripts/renderer-tunnels.d.ts +19 -21
- package/cjs/scripts/renderer-tunnels.js +52 -57
- package/cjs/types.d.ts +189 -64
- package/esm/entries/index.d.ts +1 -0
- package/esm/entries/index.js +5 -0
- package/esm/entries/main.d.ts +2 -0
- package/esm/entries/main.js +5 -0
- package/esm/entries/preload.d.ts +3 -0
- package/esm/entries/preload.js +7 -0
- package/esm/entries/renderer.d.ts +2 -0
- package/esm/entries/renderer.js +6 -0
- package/esm/enums.d.ts +5 -14
- package/esm/enums.js +11 -22
- package/esm/errors.d.ts +42 -10
- package/esm/errors.js +69 -16
- package/esm/helpers.d.ts +41 -0
- package/esm/helpers.js +96 -0
- package/esm/index.d.ts +4 -4
- package/esm/index.js +3 -3
- package/esm/main.d.ts +2 -4
- package/esm/main.js +1 -3
- package/esm/preload.d.ts +2 -2
- package/esm/preload.js +1 -1
- package/esm/renderer.d.ts +1 -1
- package/esm/scripts/base-bridge.d.ts +95 -0
- package/esm/scripts/base-bridge.js +125 -0
- package/esm/scripts/bridge.d.ts +3 -3
- package/esm/scripts/bridge.js +49 -37
- package/esm/scripts/helpers/electron-importer.d.ts +4 -0
- package/esm/scripts/helpers/electron-importer.js +16 -0
- package/esm/scripts/helpers/env.d.ts +19 -0
- package/esm/scripts/helpers/env.js +25 -0
- package/esm/scripts/helpers/error-thrower.d.ts +3 -0
- package/esm/scripts/helpers/error-thrower.js +5 -0
- package/esm/scripts/helpers/errors.d.ts +12 -0
- package/esm/scripts/helpers/errors.js +14 -0
- package/esm/scripts/helpers/id.d.ts +9 -0
- package/esm/scripts/helpers/id.js +11 -0
- package/esm/scripts/helpers/index.d.ts +8 -0
- package/esm/scripts/helpers/index.js +8 -0
- package/esm/scripts/helpers/ipc-channel.d.ts +75 -0
- package/esm/scripts/helpers/ipc-channel.js +76 -0
- package/esm/scripts/helpers/ipc-event-in-main.d.ts +24 -0
- package/esm/scripts/helpers/ipc-event-in-main.js +27 -0
- package/esm/scripts/helpers/ipc-result.d.ts +26 -0
- package/esm/scripts/helpers/ipc-result.js +42 -0
- package/esm/scripts/helpers/main-event.d.ts +8 -0
- package/esm/scripts/helpers/main-event.js +12 -0
- package/esm/scripts/helpers/transfer.d.ts +33 -0
- package/esm/scripts/helpers/transfer.js +54 -0
- package/esm/scripts/helpers/web-contents-container.d.ts +12 -0
- package/esm/scripts/helpers/web-contents-container.js +31 -0
- package/esm/scripts/helpers/web-contents-events-container.d.ts +56 -0
- package/esm/scripts/helpers/web-contents-events-container.js +78 -0
- package/esm/scripts/main/publish.d.ts +36 -0
- package/esm/scripts/main/publish.js +179 -0
- package/esm/scripts/main.d.ts +3 -3
- package/esm/scripts/main.js +41 -39
- package/esm/scripts/preload/bridge.d.ts +27 -0
- package/esm/scripts/preload/bridge.js +77 -0
- package/esm/scripts/preload/provider.d.ts +7 -0
- package/esm/scripts/preload/provider.js +84 -0
- package/esm/scripts/preload-bridge.d.ts +20 -0
- package/esm/scripts/preload-bridge.js +68 -0
- package/esm/scripts/preload-provider.js +34 -50
- package/esm/scripts/provider.d.ts +17 -15
- package/esm/scripts/provider.js +70 -91
- package/esm/scripts/publish.d.ts +19 -18
- package/esm/scripts/publish.js +89 -162
- package/esm/scripts/renderer/bridge.d.ts +6 -0
- package/esm/scripts/renderer/bridge.js +69 -0
- package/esm/scripts/renderer/tunnels.d.ts +171 -0
- package/esm/scripts/renderer/tunnels.js +203 -0
- package/esm/scripts/renderer-tunnels.d.ts +19 -21
- package/esm/scripts/renderer-tunnels.js +53 -55
- package/esm/types.d.ts +189 -64
- package/package.json +23 -41
- package/cjs/exp.d.ts +0 -4
- package/cjs/exp.js +0 -19
- package/cjs/scripts/main.d.ts +0 -8
- package/cjs/scripts/main.js +0 -72
- package/cjs/scripts/new-decorators.d.ts +0 -150
- package/cjs/scripts/new-decorators.js +0 -141
- package/cjs/scripts/old-decorators.d.ts +0 -185
- package/cjs/scripts/old-decorators.js +0 -132
- package/esm/exp.d.ts +0 -4
- package/esm/exp.js +0 -3
- package/esm/scripts/new-decorators.d.ts +0 -150
- package/esm/scripts/new-decorators.js +0 -132
- package/esm/scripts/old-decorators.d.ts +0 -185
- package/esm/scripts/old-decorators.js +0 -122
package/LICENCE
CHANGED
package/README.md
CHANGED
|
@@ -1,461 +1,268 @@
|
|
|
1
1
|
# Electron main-renderer bridge (emr-bridge)
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
JS library for easily providing access to the **main** from the **renderer** process
|
|
5
|
-
|
|
6
|
-
## Table of contents
|
|
7
|
-
|
|
8
|
-
- [Installation](#installation)
|
|
9
|
-
- [Usage](#usage)
|
|
10
|
-
- [static](#static-methods-and-properties)
|
|
11
|
-
- [non-static](#methods-and-properties)
|
|
12
|
-
- [functions and variables](#functions-and-variables)
|
|
13
|
-
- [scopes](#scopes)
|
|
14
|
-
- [access](#restricting-access-to-variables)
|
|
15
|
-
- [usage in renderer](#access-from-renderer-and-preload)
|
|
16
|
-
- [promises](#promises)
|
|
17
|
-
- [events](#events-system)
|
|
18
|
-
|
|
19
|
-
## Installation
|
|
20
|
-
|
|
21
|
-
```text
|
|
22
|
-
npm i emr-bridge
|
|
23
|
-
```
|
|
3
|
+
_Только для Electron._
|
|
24
4
|
|
|
25
|
-
|
|
5
|
+
_Полная поддержка TypeScript._
|
|
26
6
|
|
|
27
|
-
|
|
7
|
+
Уменьшает boilerplate при работе с **Electron IPC**:
|
|
8
|
+
- Функционал событий.
|
|
9
|
+
- Лёгкая передача экземпляров классов.
|
|
10
|
+
- Простое использование промисов.
|
|
11
|
+
- Быстрая публикация переменных и функций из `main` в `renderer` / `preload`.
|
|
28
12
|
|
|
29
|
-
|
|
13
|
+
## Содержание
|
|
30
14
|
|
|
31
|
-
|
|
15
|
+
- [Установка](#установка)
|
|
16
|
+
- [Использование](#использование)
|
|
17
|
+
- [публикация](#публикация-функций-и-переменных)
|
|
18
|
+
- [renderer и preload](#использование-в-renderer-и-preload)
|
|
19
|
+
- [промисы](#промисы)
|
|
20
|
+
- [события](#события)
|
|
21
|
+
- [передача экземпляров классов](#передача-экземпляров-классов)
|
|
32
22
|
|
|
33
|
-
|
|
34
|
-
// Preload process
|
|
35
|
-
import { provideFromMain } from 'emr-bridge'
|
|
23
|
+
## Установка
|
|
36
24
|
|
|
37
|
-
|
|
25
|
+
```cmd
|
|
26
|
+
npm i emr-bridge@latest
|
|
38
27
|
```
|
|
39
28
|
|
|
40
|
-
|
|
29
|
+
Для работы библиотеки требуется вставить следующий код в preload процесс.
|
|
41
30
|
|
|
42
31
|
```js
|
|
43
|
-
|
|
44
|
-
import { providePublic } from 'emr-bridge/exp'
|
|
32
|
+
import { provideFromMain } from 'emr-bridge/preload'
|
|
45
33
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
const instance = providePublic(new MainPublic())
|
|
34
|
+
provideFromMain(true /* context isolation */)
|
|
49
35
|
```
|
|
50
36
|
|
|
51
|
-
|
|
37
|
+
## Использование
|
|
52
38
|
|
|
53
|
-
|
|
39
|
+
*Если требуется CommonJS, то используем `emr-bridge/cjs`*.
|
|
54
40
|
|
|
55
|
-
|
|
41
|
+
### Публикация функций и переменных
|
|
56
42
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
import { publicMethod, publicProperty, publicGetter, publicSetter, Access } from 'emr-bridge'
|
|
60
|
-
|
|
61
|
-
class User {
|
|
62
|
-
private static name = 'Name'
|
|
63
|
-
private static age = 20
|
|
64
|
-
private static money = 1000
|
|
65
|
-
|
|
66
|
-
@publicGetter('userBalance')
|
|
67
|
-
static get balance(): string {
|
|
68
|
-
return `${this.money}$`
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
@publicSetter('userBalance')
|
|
72
|
-
static set balance(newBalance: string) {
|
|
73
|
-
this.money = Number(newBalance.split('$')[0])
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
@publicGetter({
|
|
77
|
-
name: 'userInfo',
|
|
78
|
-
access: Access.get
|
|
79
|
-
})
|
|
80
|
-
static get info(): string {
|
|
81
|
-
return `Name: '${this.name}'; Age: '${this.age}'; Money: '${this.money}';`
|
|
82
|
-
}
|
|
43
|
+
Для публикации функций и переменных из `main` процесса библиотека предоставляет
|
|
44
|
+
функции `publishFunction` и `publishVariable` из **emr-bridge/main**.
|
|
83
45
|
|
|
84
|
-
|
|
85
|
-
static id = 'ID_AJWD3KLW23DK231K'
|
|
86
|
-
|
|
87
|
-
@publicMethod()
|
|
88
|
-
static setName(newName: string): void {
|
|
89
|
-
this.name = newName
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
@publicMethod('getUserAge')
|
|
93
|
-
static getAge(): number {
|
|
94
|
-
return this.age
|
|
95
|
-
}
|
|
96
|
-
}
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
### Methods and properties
|
|
100
|
-
|
|
101
|
-
Use **publicMethod**/**publicProperty**/**publicGetter**/**publicSetter**.
|
|
102
|
-
|
|
103
|
-
```ts
|
|
46
|
+
```js
|
|
104
47
|
// Main process
|
|
105
|
-
import {
|
|
106
|
-
|
|
107
|
-
class User {
|
|
108
|
-
private name = 'Name'
|
|
109
|
-
private age = 20
|
|
110
|
-
private money = 1000
|
|
111
|
-
|
|
112
|
-
@publicProperty()
|
|
113
|
-
id = 'ID_AJWD3KLW23DK231K'
|
|
114
|
-
|
|
115
|
-
@publicGetter()
|
|
116
|
-
get balance(): string {
|
|
117
|
-
return `${this.money}$`
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
@publicSetter()
|
|
121
|
-
set balance(newBalance: string) {
|
|
122
|
-
this.money = Number(newBalance.split('$')[0])
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
@publicGetter({
|
|
126
|
-
name: 'userInfo',
|
|
127
|
-
access: Access.get
|
|
128
|
-
})
|
|
129
|
-
get info(): string {
|
|
130
|
-
return `Name: '${this.name}'; Age: '${this.age}'; Money: '${this.money}';`
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
@publicMethod()
|
|
134
|
-
setName(newName: string): void {
|
|
135
|
-
this.name = newName
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
@publicMethod('getUserAge')
|
|
139
|
-
getAge(): number {
|
|
140
|
-
return this.age
|
|
141
|
-
}
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
const user = new User()
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
### Functions and variables
|
|
48
|
+
import { publishFunction, publishVariable } from 'emr-bridge/main'
|
|
148
49
|
|
|
149
|
-
|
|
50
|
+
publishFunction('sayHello', name => {
|
|
51
|
+
return `Hello, ${name}!`
|
|
52
|
+
})
|
|
150
53
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
publicFunction('sayHello', sayHello)
|
|
156
|
-
publicFunction('getUserName', getName)
|
|
157
|
-
publicVariable('count', {
|
|
158
|
-
get(): number {
|
|
159
|
-
return count
|
|
160
|
-
},
|
|
161
|
-
set(value: number) {
|
|
162
|
-
count = value
|
|
54
|
+
publishFunction('getUser', () => {
|
|
55
|
+
return {
|
|
56
|
+
name: 'Name',
|
|
57
|
+
age: 20
|
|
163
58
|
}
|
|
164
59
|
})
|
|
165
60
|
|
|
166
61
|
let count = 0
|
|
167
62
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
}
|
|
172
|
-
|
|
173
|
-
function sayHello(name: string): string {
|
|
174
|
-
return `Hello, ${name}!`
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
function getName(): string {
|
|
178
|
-
return user.name
|
|
179
|
-
}
|
|
63
|
+
publishVariable('count', {
|
|
64
|
+
get: () => count,
|
|
65
|
+
set: value => count = value
|
|
66
|
+
})
|
|
180
67
|
```
|
|
181
68
|
|
|
182
|
-
###
|
|
69
|
+
### Использование в renderer и preload
|
|
183
70
|
|
|
184
|
-
|
|
71
|
+
Пример использования ранее опубликованных функций и переменных.
|
|
185
72
|
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
// Main process
|
|
190
|
-
|
|
191
|
-
// static and non-static
|
|
192
|
-
import { Scope, Access, publicMethod, publicGetter } from 'emr-bridge'
|
|
73
|
+
```js
|
|
74
|
+
// Renderer process
|
|
75
|
+
import { Bridge } from 'emr-bridge/renderer'
|
|
193
76
|
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
private name = 'Name'
|
|
197
|
-
|
|
198
|
-
@publicGetter({
|
|
199
|
-
scope: Scope.preload,
|
|
200
|
-
access: Access.get
|
|
201
|
-
})
|
|
202
|
-
get count(): number {
|
|
203
|
-
return 30
|
|
204
|
-
}
|
|
205
|
-
|
|
206
|
-
@publicMethod({ scope: Scope.preload })
|
|
207
|
-
static getAge(): number {
|
|
208
|
-
return this.age
|
|
209
|
-
}
|
|
210
|
-
|
|
211
|
-
@publicMethod({
|
|
212
|
-
name: 'getUserName',
|
|
213
|
-
scope: Scope.renderer
|
|
214
|
-
})
|
|
215
|
-
getName(): string {
|
|
216
|
-
return this.name
|
|
217
|
-
}
|
|
218
|
-
}
|
|
77
|
+
// `as` в TypeScript позволяет кастовать в нужный тип.
|
|
78
|
+
const bridge = Bridge.as()
|
|
219
79
|
|
|
220
|
-
|
|
221
|
-
|
|
80
|
+
// Выведет текущее значение count из main (0).
|
|
81
|
+
console.log(bridge.count)
|
|
222
82
|
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
// functions and variables
|
|
226
|
-
import { publicFunction, publicVariable, Scope } from 'emr-bridge'
|
|
227
|
-
|
|
228
|
-
publicFunction('getName', getName, [Scope.preload])
|
|
229
|
-
publicVariable('count', {
|
|
230
|
-
get(): number {
|
|
231
|
-
return count
|
|
232
|
-
},
|
|
233
|
-
set(value: number) {
|
|
234
|
-
count = value
|
|
235
|
-
}
|
|
236
|
-
}, [Scope.renderer])
|
|
83
|
+
// Увеличит значение count в main на единицу.
|
|
84
|
+
bridge.count++
|
|
237
85
|
|
|
238
|
-
|
|
86
|
+
// { name: 'Name', age: 20 }.
|
|
87
|
+
bridge.getUser()
|
|
239
88
|
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
}
|
|
89
|
+
// 'Hello, Aleksandr!'.
|
|
90
|
+
bridge.seyHello('Aleksandr')
|
|
243
91
|
```
|
|
244
92
|
|
|
245
|
-
|
|
246
|
-
Using an entity outside the specified scope _will cause an error_.
|
|
93
|
+
Для `preload` процесса всё идентично, но требуется импортировать из **emr-bridge/preload**.
|
|
247
94
|
|
|
248
|
-
###
|
|
95
|
+
### Промисы
|
|
249
96
|
|
|
250
|
-
|
|
251
|
-
// Main process
|
|
252
|
-
// static and non-static
|
|
253
|
-
import { publicGetter, Access } from 'emr-bridge'
|
|
254
|
-
|
|
255
|
-
class User {
|
|
256
|
-
private static name = 'Name'
|
|
257
|
-
private static surname = 'Surname'
|
|
258
|
-
|
|
259
|
-
@publicGetter({ access: Access.get })
|
|
260
|
-
static get fullName(): string {
|
|
261
|
-
return `${this.name} ${this.surname}`
|
|
262
|
-
}
|
|
263
|
-
|
|
264
|
-
@publicProperty({
|
|
265
|
-
name: 'userAge',
|
|
266
|
-
access: Access.get
|
|
267
|
-
})
|
|
268
|
-
get age(): number {
|
|
269
|
-
return 20
|
|
270
|
-
}
|
|
271
|
-
}
|
|
272
|
-
|
|
273
|
-
new User()
|
|
274
|
-
```
|
|
97
|
+
Поддержка промисов реализована "из коробки".
|
|
275
98
|
|
|
276
|
-
```
|
|
99
|
+
```js
|
|
277
100
|
// Main process
|
|
278
|
-
|
|
279
|
-
import { publicVariable } from 'emr-bridge'
|
|
280
|
-
|
|
281
|
-
publicVariable('count', {
|
|
282
|
-
// get access
|
|
283
|
-
get(): number {
|
|
284
|
-
return count
|
|
285
|
-
},
|
|
286
|
-
// set access
|
|
287
|
-
set(value: number) {
|
|
288
|
-
count = value
|
|
289
|
-
}
|
|
290
|
-
})
|
|
101
|
+
import { publishFunction } from 'emr-bridge/main'
|
|
291
102
|
|
|
292
|
-
|
|
103
|
+
publishFunction('after1s', () => {
|
|
104
|
+
return new Promise(resolve => {
|
|
105
|
+
setTimeout(() => resolve('after1s'), 1000)
|
|
106
|
+
})
|
|
107
|
+
})
|
|
293
108
|
```
|
|
294
109
|
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
110
|
+
```js
|
|
111
|
+
// Renderer process
|
|
112
|
+
import { Bridge } from 'emr-bridge/renderer'
|
|
298
113
|
|
|
299
|
-
|
|
300
|
-
// Preload process
|
|
301
|
-
import { Main, provideFromMain } from 'emr-bridge/preload'
|
|
114
|
+
const bridge = Bridge.as()
|
|
302
115
|
|
|
303
|
-
|
|
116
|
+
async function foo() {
|
|
117
|
+
const result = await bridge.after1s()
|
|
304
118
|
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
setUserAge(newAge: number): void
|
|
308
|
-
count: number
|
|
119
|
+
// Через 1 секунду выведет сообщение 'after1s', полученное из main.
|
|
120
|
+
console.log(result)
|
|
309
121
|
}
|
|
122
|
+
```
|
|
310
123
|
|
|
311
|
-
|
|
124
|
+
### События
|
|
312
125
|
|
|
313
|
-
|
|
314
|
-
main.count++
|
|
315
|
-
main.setUserAge(20)
|
|
316
|
-
```
|
|
126
|
+
Пример обработки события, которое вызывается из `renderer` или `preload`.
|
|
317
127
|
|
|
318
|
-
|
|
128
|
+
```js
|
|
129
|
+
// Main process
|
|
130
|
+
import { on, once } from 'emr-bridge/main'
|
|
319
131
|
|
|
320
|
-
|
|
132
|
+
on('message-from-renderer', message => console.log(message))
|
|
133
|
+
// once('message-from-renderer', message => console.log(message))
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
```js
|
|
321
137
|
// Renderer process
|
|
322
138
|
import { Bridge } from 'emr-bridge/renderer'
|
|
323
139
|
|
|
324
|
-
|
|
325
|
-
getUserName(): string
|
|
326
|
-
setUserAge(newAge: number): void
|
|
327
|
-
count: number
|
|
328
|
-
}
|
|
329
|
-
|
|
330
|
-
const bridge = Bridge.as<IProvidedPubic>()
|
|
140
|
+
const bridge = Bridge.as()
|
|
331
141
|
|
|
332
|
-
|
|
333
|
-
bridge.
|
|
334
|
-
bridge.setUserAge(30)
|
|
142
|
+
// Вызовет событие и выведет в консоль main процесса 'Hello from renderer'
|
|
143
|
+
bridge.emit('message-from-renderer', 'Hello from renderer')
|
|
335
144
|
```
|
|
336
145
|
|
|
337
|
-
|
|
146
|
+
Пример обработки события, которое вызывается из `main`.
|
|
338
147
|
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
```ts
|
|
148
|
+
```js
|
|
342
149
|
// Main process
|
|
343
|
-
import {
|
|
150
|
+
import { emitEvent } from 'emr-bridge/main'
|
|
344
151
|
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
setTimeout(resolve, 1000)
|
|
348
|
-
})
|
|
349
|
-
})
|
|
152
|
+
// Вызовет событие и выведет в консоль renderer процесса 'Hello from main'
|
|
153
|
+
emitEvent('message-from-main', 'Hello from main')
|
|
350
154
|
```
|
|
351
155
|
|
|
352
|
-
```
|
|
156
|
+
```js
|
|
353
157
|
// Renderer process
|
|
354
158
|
import { Bridge } from 'emr-bridge/renderer'
|
|
355
159
|
|
|
356
|
-
|
|
357
|
-
delay1s(): Promise<void>
|
|
358
|
-
}
|
|
359
|
-
|
|
360
|
-
const bridge = Bridge.as<IPublic>()
|
|
160
|
+
const bridge = Bridge.as()
|
|
361
161
|
|
|
362
|
-
bridge.
|
|
162
|
+
bridge.on('message-from-main', message => console.log(message))
|
|
363
163
|
```
|
|
364
164
|
|
|
365
|
-
###
|
|
165
|
+
### Передача экземпляров классов
|
|
366
166
|
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
```ts
|
|
370
|
-
// Main process
|
|
371
|
-
import { publicMainEvent, publicClassMainEvent } from 'emr-bridge'
|
|
167
|
+
По умолчанию, передача экземпляров пользовательских классов через IPC невозможна.
|
|
372
168
|
|
|
373
|
-
|
|
374
|
-
setInterval(tickWithReceiver, 1000)
|
|
169
|
+
Библиотека решает эту проблему путём реализации паттерна 'Снимок'.
|
|
375
170
|
|
|
376
|
-
|
|
377
|
-
const tick = publicMainEvent('tick')
|
|
378
|
-
setInterval(() => tick(new Date().toTimeString()), 1000)
|
|
171
|
+
Передаваемый класс должен реализовать функции `getSnapshot` и `updateFromSnapshot`, а также иметь конструктор без параметров.
|
|
379
172
|
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
173
|
+
```js
|
|
174
|
+
// Human.js
|
|
175
|
+
export default class Human {
|
|
176
|
+
name = undefined
|
|
177
|
+
age = undefined
|
|
178
|
+
|
|
179
|
+
constructor(
|
|
180
|
+
name = 'Aleksandr',
|
|
181
|
+
age = 30
|
|
182
|
+
) {
|
|
183
|
+
this.name = name
|
|
184
|
+
this.age = age
|
|
185
|
+
}
|
|
389
186
|
|
|
390
|
-
|
|
391
|
-
|
|
187
|
+
getSnapshot() {
|
|
188
|
+
return {
|
|
189
|
+
name: this.name,
|
|
190
|
+
age: this.age
|
|
191
|
+
}
|
|
192
|
+
}
|
|
392
193
|
|
|
393
|
-
|
|
394
|
-
|
|
194
|
+
updateFromSnapshot(snapshot) {
|
|
195
|
+
this.name = snapshot.name
|
|
196
|
+
this.age = snapshot.age
|
|
197
|
+
}
|
|
395
198
|
}
|
|
396
|
-
const events = new MainPublicEvents()
|
|
397
|
-
setInterval(events.tickWithReceiver, 1000)
|
|
398
|
-
setInterval(() => events.tick(new Date().toTimeString()), 1000)
|
|
399
|
-
events.pay(200)
|
|
400
199
|
```
|
|
401
200
|
|
|
402
|
-
|
|
403
|
-
// Renderer process
|
|
404
|
-
import { Bridge, MainEvent } from 'emr-bridge/renderer'
|
|
201
|
+
Для передачи экземпляра класса требуется на **принимающей** стороне передать сам класс в качестве аргумента функции:
|
|
405
202
|
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
203
|
+
```js
|
|
204
|
+
// Main process
|
|
205
|
+
import { publishFunction } from 'emr-bridge/main'
|
|
206
|
+
import Human from './Human'
|
|
207
|
+
|
|
208
|
+
// Выводим имя человека, переданного из `preload` или `renderer`.
|
|
209
|
+
publishFunction(
|
|
210
|
+
'displayName',
|
|
211
|
+
human => console.log(human.name),
|
|
212
|
+
/* Говорим какие классы надо принять.
|
|
213
|
+
Порядок в массиве соответствует порядку таких аргументов в функции.
|
|
214
|
+
Для (human, car, engine) будет [Human, Car, Engine].
|
|
215
|
+
Для (human, surname, car) будет [Human, Car], так как 'surname' имеет стандартный тип String.
|
|
216
|
+
Стандартные типы (String, Number..) указывать не требуется. */
|
|
217
|
+
[Human]
|
|
218
|
+
)
|
|
219
|
+
|
|
220
|
+
/* У событий также есть такой аргумент
|
|
221
|
+
on('displayName', human => console.log(human.name), [Human])
|
|
222
|
+
once('displayName', human => console.log(human.name), [Human])
|
|
223
|
+
*/
|
|
417
224
|
```
|
|
418
225
|
|
|
419
|
-
|
|
226
|
+
```js
|
|
227
|
+
// Renderer process
|
|
228
|
+
import { Bridge } from 'emr-bridge/renderer'
|
|
229
|
+
import Human from './Human'
|
|
420
230
|
|
|
421
|
-
|
|
422
|
-
// Main process
|
|
423
|
-
import { publicRendererEvent, publicClassRendererEvent, RendererEvent } from 'emr-bridge'
|
|
231
|
+
const bridge = Bridge.as()
|
|
424
232
|
|
|
425
|
-
|
|
426
|
-
|
|
233
|
+
// Передаст данные через создание снимка.
|
|
234
|
+
bridge.displayName(new Human('Dima', 25))
|
|
235
|
+
```
|
|
427
236
|
|
|
428
|
-
|
|
429
|
-
const onMessageWithReceiver = publicRendererEvent('onMessageWithReceiver', (message: string) => `Message: ${message}`)
|
|
430
|
-
onMessageWithReceiver(message => console.log(message))
|
|
237
|
+
Для получения экземпляра класса из `main` в `renderer` или `preload` нужно использовать `bridge.call`.
|
|
431
238
|
|
|
239
|
+
_Такое требование связано со сложностью реализации._
|
|
432
240
|
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
241
|
+
```js
|
|
242
|
+
// Main process
|
|
243
|
+
import { publishFunction } from 'emr-bridge/main'
|
|
244
|
+
import Human from './Human'
|
|
437
245
|
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
}
|
|
441
|
-
const events = new RendererPublicEvents()
|
|
442
|
-
events.onMessage(message => console.log(message))
|
|
443
|
-
events.onMessageWithReceiver(message => console.log(message))
|
|
246
|
+
// Передаём человека в `preload` или `renderer` процесс.
|
|
247
|
+
publishFunction('getHuman', () => new Human('Artem', 40))
|
|
444
248
|
```
|
|
445
249
|
|
|
446
|
-
```
|
|
250
|
+
```js
|
|
447
251
|
// Renderer process
|
|
448
252
|
import { Bridge } from 'emr-bridge/renderer'
|
|
253
|
+
import Human from './Human'
|
|
449
254
|
|
|
450
|
-
|
|
451
|
-
message(message: string): void
|
|
452
|
-
messageWithReceiver(message: string): void
|
|
453
|
-
}
|
|
255
|
+
const bridge = Bridge.as()
|
|
454
256
|
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
bridge.
|
|
458
|
-
|
|
459
|
-
|
|
257
|
+
// Выведет в консоль 25
|
|
258
|
+
console.log(
|
|
259
|
+
bridge.call(bridge.getHuman, Human).name
|
|
260
|
+
)
|
|
261
|
+
|
|
262
|
+
/* Альтернативный вариант
|
|
263
|
+
// Оборачиваем оригинал новой функцией, которая автоматически преобразует ответ в нужный класс.
|
|
264
|
+
bridge.getHuman = bridge.returns(bridge.getHuman, Human)
|
|
460
265
|
|
|
461
|
-
|
|
266
|
+
console.log(bridge.getHuman().name)
|
|
267
|
+
*/
|
|
268
|
+
```
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type { EventListener, EventUnsubscribe, HasSnapshotClass, IBridge, IHasSnapshot } from '../types.js';
|