forked from alexaubry/JavaScriptKit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathJSExpression.html
More file actions
275 lines (260 loc) · 12.7 KB
/
JSExpression.html
File metadata and controls
275 lines (260 loc) · 12.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<!DOCTYPE html>
<html lang="en">
<head>
<title>JSExpression Protocol Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Protocol/JSExpression" class="dashAnchor"></a>
<a title="JSExpression Protocol Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">JavaScriptKit Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/alexaubry/JavaScriptKit"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Falexaubry%2Egithub%2Eio%2Fdocsets%2FJavaScriptKit%2Exml"><img src="../img/dash.png"/>Install in Dash</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">JavaScriptKit Reference</a>
<img id="carat" src="../img/carat.png" />
JSExpression Protocol Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Classes/JSFunction.html">JSFunction</a>
</li>
<li class="nav-group-task">
<a href="../Classes/JSScript.html">JSScript</a>
</li>
<li class="nav-group-task">
<a href="../Classes/JSVariable.html">JSVariable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enums</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/JSDecodingStrategy.html">JSDecodingStrategy</a>
</li>
<li class="nav-group-task">
<a href="../Enums/JSErrorDomain.html">JSErrorDomain</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/JSExpression.html">JSExpression</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/JSVoid.html">JSVoid</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>JSExpression</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">JSExpression</span></code></pre>
</div>
</div>
<p>A JavaScript expression that can be evaluated inside of a web view (<code>WKWebView</code>).</p>
<p>The library provides ready-to-use expression implementations:</p>
<ul>
<li><code><a href="../Classes/JSVariable.html">JSVariable</a></code> to access a variable</li>
<li><code><a href="../Classes/JSFunction.html">JSFunction</a></code> to call a function</li>
<li><code><a href="../Classes/JSScript.html">JSScript</a></code> to run a custom script</li>
</ul>
<p>You don’t need to implement this protocol yourself.</p>
<p>Expressions are specialized with the <code>ReturnType</code> associated type. Expressions can return any
<code>Decodable</code> type. This includes:</p>
<ul>
<li><code><a href="../Structs/JSVoid.html">JSVoid</a></code> for expressions that do not return a value</li>
<li>Primitive values (Strings, Numbers, Booleans, …)</li>
<li>Decodable enumerations</li>
<li>Objects decodable from JSON</li>
<li>Arrays of primitive values</li>
<li>Arrays of enumeration cases</li>
<li>Arrays of objects</li>
<li>Native dictionaries</li>
</ul>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:13JavaScriptKit12JSExpressionP10ReturnType"></a>
<a name="//apple_ref/swift/Alias/ReturnType" class="dashAnchor"></a>
<a class="token" href="#/s:13JavaScriptKit12JSExpressionP10ReturnType">ReturnType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The expected return type of the expression.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">associatedtype</span> <span class="kt">ReturnType</span><span class="p">:</span> <span class="kt">Decodable</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/alexaubry/JavaScriptKit/tree/master/Sources/JSExpression.swift#L36">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13JavaScriptKit12JSExpressionP20makeExpressionStringSSyKF"></a>
<a name="//apple_ref/swift/Method/makeExpressionString()" class="dashAnchor"></a>
<a class="token" href="#/s:13JavaScriptKit12JSExpressionP20makeExpressionStringSSyKF">makeExpressionString()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates the JavaScript text of the expression.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">makeExpressionString</span><span class="p">()</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/alexaubry/JavaScriptKit/tree/master/Sources/JSExpression.swift#L39">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:13JavaScriptKit12JSExpressionPAAE8evaluateySo9WKWebViewC2in_y6ResultAHOy10ReturnTypeQzAA13JSErrorDomainOGcSg17completionHandlertF"></a>
<a name="//apple_ref/swift/Method/evaluate(in:completionHandler:)" class="dashAnchor"></a>
<a class="token" href="#/s:13JavaScriptKit12JSExpressionPAAE8evaluateySo9WKWebViewC2in_y6ResultAHOy10ReturnTypeQzAA13JSErrorDomainOGcSg17completionHandlertF">evaluate(in:completionHandler:)</a>
</code>
<span class="declaration-note">
Extension method
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Evaluates the expression inside of a web view’s JavaScript context.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
<p>The completion handler always runs on the main thread.</p>
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">evaluate</span><span class="p">(</span><span class="k">in</span> <span class="nv">webView</span><span class="p">:</span> <span class="kt">WKWebView</span><span class="p">,</span>
<span class="nv">completionHandler</span><span class="p">:</span> <span class="p">((</span><span class="n">_</span> <span class="nv">result</span><span class="p">:</span> <span class="kt">Result</span><span class="o"><</span><span class="kt"><a href="../Protocols/JSExpression.html#/s:13JavaScriptKit12JSExpressionP10ReturnType">ReturnType</a></span><span class="p">,</span> <span class="kt"><a href="../Enums/JSErrorDomain.html">JSErrorDomain</a></span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)?)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>webView</em>
</code>
</td>
<td>
<div>
<p>The web view to execute the code in.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completionHandler</em>
</code>
</td>
<td>
<div>
<p>The code to execute with the execution result.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>result</em>
</code>
</td>
<td>
<div>
<p>The result of the evaluation. Will be <code>.success(ReturnType)</code> if a valid
return value was parsed ; or <code>.error(JSErrorDomain)</code> if an error was thrown by the web view
when evaluating the script.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/alexaubry/JavaScriptKit/tree/master/Sources/JSExpression.swift#L117-L134">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>Copyright © 2017 Alexis Aubry. Available under the MIT License.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>