Repository navigation
Expand file tree
/
Copy pathindex.html
More file actions
249 lines (249 loc) · 13.7 KB
/
Copy pathindex.html
File metadata and controls
249 lines (249 loc) · 13.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
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Replicache</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">Replicache</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1>Replicache</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#replicache-js-sdk" id="replicache-js-sdk" style="color: inherit; text-decoration: none;">
<h1>Replicache JS SDK</h1>
</a>
<p><img src="https://github.com/rocicorp/replicache-sdk-js/workflows/Node.js%20CI/badge.svg" alt="Node.js CI"></p>
<a href="#development-instructions" id="development-instructions" style="color: inherit; text-decoration: none;">
<h2>Development Instructions</h2>
</a>
<p>Eventually you will be able to <code>npm install</code> but until then...</p>
<a href="#get-the-code" id="get-the-code" style="color: inherit; text-decoration: none;">
<h3>Get the Code</h3>
</a>
<p>Either by <code>npm install</code>'ing the git repo, cloning it, or downloading a
release.</p>
<a href="#build-the-js" id="build-the-js" style="color: inherit; text-decoration: none;">
<h3>Build the JS</h3>
</a>
<p>Replicache JS SDK is written in TypeScript. Run <code>npm run build</code> to generate the JS source code (JS source is outputted in <code>out/</code>). By default we generate browser compatible JS but you can also build CommonJS modules by running <code>npm run build:cjs</code>. Let us know what your needs are.</p>
<a href="#get-binaries" id="get-binaries" style="color: inherit; text-decoration: none;">
<h3>Get Binaries</h3>
</a>
<p>Download required helper binaries: <code>npm run build:binaries</code>. Do this again whenever you update the SDK.</p>
<a href="#run-test-server" id="run-test-server" style="color: inherit; text-decoration: none;">
<h3>Run <code>test-server</code></h3>
</a>
<p>Currently, the JavaScript SDK relies on a native local server that
implements the guts of the sync protocol on the client side. This is
temporary and will be removed.</p>
<p>For now, you must have this server running whenever you are working
with the SDK:</p>
<pre><code>mkdir ~/.repm
npm <span class="hljs-builtin-name">run</span> start:test-server -- <span class="hljs-attribute">--storage-dir</span>=<span class="hljs-variable">$HOME</span>/.repm</code></pre>
<a href="#start-y
8000
our-data-layer" id="start-your-data-layer" style="color: inherit; text-decoration: none;">
<h3>Start your Data Layer</h3>
</a>
<p>See <a href="https://github.com/rocicorp/replicache#server-side">Replicache Server Setup</a> for server-side instructions.</p>
<p>For the rest of these instructions we will assume your data layer is
running on <code>localhost:3000</code>.</p>
<a href="#start-diff-server" id="start-diff-server" style="color: inherit; text-decoration: none;">
<h3>Start Diff-Server</h3>
</a>
<p>In production, your app will talk to the production Replicache diff-server at <a href="https://serve.replicache.dev/">https://serve.replicache.dev/</a>.</p>
<p>During development, that sever can't reach your workstation, so we
provide a development instance to work against instead. Leave this
running in a tab:</p>
<pre><code class="language-bash"><span class="hljs-comment"># The --client-view flag should point to the Client View endpoint</span>
<span class="hljs-comment"># on your development data layer.</span>
npm run start:diff-server -- --client-view=<span class="hljs-string">"http://localhost:3000/replicache-client-view"</span></code></pre>
<a href="#including-the-js" id="including-the-js" style="color: inherit; text-decoration: none;">
<h3>Including the JS</h3>
</a>
<p>By default we only compile the TS to an ES module.</p>
<pre><code class="language-js"><span class="hljs-keyword">import</span> Replicache, {REPMHTTPInvoker} <span class="hljs-keyword">from</span> <span class="hljs-string">'./out/mod.js'</span>;</code></pre>
<p>To use <code>Replicache</code> you currently have to tell it how to invoke the <strong>Rep</strong>licache Client API <strong>M</strong>odule (REPM).</p>
<pre><code class="language-js"><span class="hljs-keyword">const</span> diffServerURL = <span class="hljs-string">'https://serve.replicache.dev/pull'</span>;
<span class="hljs-keyword">const</span> diffServerAuth = <span class="hljs-string">'<your diff-server account ID>'</span>;
<span class="hljs-keyword">const</span> batchURL = <span class="hljs-string">'https://youservice.com/replicache-batch'</span>;
<span class="hljs-keyword">const</span> dataLayerAuth = <span class="hljs-string">'<your data-layer auth token>'</span>;
<span class="hljs-keyword">const</span> repmInvoker = <span class="hljs-keyword">new</span> REPMHTTPInvoker(<span class="hljs-string">'http://localhost:7002'</span>);
<span class="hljs-keyword">const</span> repmInvoke = repmInvoker.invoke;
<span class="hljs-keyword">const</span> replicache = <span class="hljs-keyword">new</span> Replicache({
diffServerURL,
diffServerAuth,
batchURL,
dataLayerAuth,
repmInvoke,
});
<span class="hljs-keyword">await</span> replicache.query(<span class="hljs-keyword">async</span> tx => {
<span class="hljs-built_in">console</span>.log(<span class="hljs-keyword">await</span> tx.get(<span class="hljs-string">'/hello'</span>));
});</code></pre>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="classes/repmhttpinvoker.html" class="tsd-kind-icon">REPMHTTPInvoker</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/replicache.html" class="tsd-kind-icon">Replicache</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/scanresult.html" class="tsd-kind-icon">Scan<wbr>Result</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/transactionclosederror.html" class="tsd-kind-icon">Transaction<wbr>Closed<wbr>Error</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/repminvoke.html" class="tsd-kind-icon">REPMInvoke</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/readtransaction.html" class="tsd-kind-icon">Read<wbr>Transaction</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/scanbound.html" class="tsd-kind-icon">Scan<wbr>Bound</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/scanid.html" class="tsd-kind-icon">Scan<wbr>Id</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/writetransaction.html" class="tsd-kind-icon">Write<wbr>Transaction</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#databaseinfo" class="tsd-kind-icon">Database<wbr>Info</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="globals.html#mutator" class="tsd-kind-icon">Mutator</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul cla
69FB
ss="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>