replicache/docs/index.html at v3.0.0 · hmmhmmhm/replicache

Repository navigation

History

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

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

<!doctype html>

<head>

<title>Replicache</title>

</head>

<body>

<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>

</div>

<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>

<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>

<li data-value="public">Public</li>

<li data-value="protected">Public/Protected</li>

</ul>

</div>

<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>

</div>

</div>

<li>

<a href="globals.html">Globals</a>

</li>

</ul>

<h1>Replicache</h1>

</div>

</header>

<h1>Replicache JS SDK</h1>

</a>

<h3>Offline-First for Every Application</h3>

</a>

<h2>👋 Quickstart</h2>

</a>

<p>This tutorial walks through creating the UI for a basic <a href="https://replicache.dev/">Replicache</a>-powered todo list.</p>

<p>It relies on the <a href="https://github.com/rocicorp/replicache-sample-todo">replicache-sample-todo</a> backend. To learn how to setup you own Replicache backend, see <a href="https://github.com/rocicorp/replicache#server-side">Server Side Setup</a>.</p>

<p>If you have any problems or questions, please <a href="https://slack.replicache.dev/">join us on Slack</a>. We'd be happy to help.</p>

<p>You can also skip to the end and <a href="https://github.com/rocicorp/replicache-sdk-js/tree/master/sample/cal">check out the full working version of this sample</a>.</p>

<p><strong>Note:</strong> This document assumes you already know what Replicache is, why you might need it, and broadly how it works. If that's not true check out the <a href="https://github.com/rocicorp/replicache/blob/master/design.md">design document</a> for a detailed deep-dive.</p>

<h2>🏃‍♂️ Install</h2>

</a>

<pre><code>npm <span class="hljs-keyword">install</span> replicache</code></pre>

<h2>🚴🏿‍♀️ Instantiate</h2>

</a>

<p>Replicache ships with both ES6 and CommonJS modules. For simplicity, these examples use ES6.</p>

<pre><code class="language-html"><span class="hljs-tag"><<span class="hljs-name">script</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"module"</span>></span><span class="javascript">

<span class="hljs-keyword">import</span> Replicache <span class="hljs-keyword">from</span> <span class="hljs-string">'replicache'</span>; <span class="hljs-comment">// Replace with a real module path as needed...</span>

<span class="hljs-keyword">var</span> rep = <span class="hljs-keyword">new</span> Replicache({

<span class="hljs-comment">// URL of the diff server to use. The diff server periodically fetches</span>

<span class="hljs-comment">// the "client view" from your service and forwards any delta to the</span>

<span class="hljs-comment">// client. You can use our hosted diff server (as here) or a local diff</span>

<span class="hljs-comment">// server, which is useful during development. See</span>

<span class="hljs-comment">// https://github.com/rocicorp/replicache#server-side for more</span>

<span class="hljs-comment">// information on setting up your client view.</span>

<span class="hljs-attr">diffServerURL</span>: <span class="hljs-string">'https://serve.replicache.dev/pull'</span>,

<span class="hljs-comment">// Auth token for the diff server, if any.</span>

<span class="hljs-attr">diffServerAuth</span>: <span class="hljs-string">'1'</span>,

<span class="hljs-comment">// URL of your service's Replicache batch endpoint. Replicache</span>

<span class="hljs-comment">// will send batches of mutations here for application.</span>

<span class="hljs-attr">batchURL</span>: <span class="hljs-string">'https://replicache-sample-todo.now.sh/serve/replicache-batch'</span>,

<span class="hljs-comment">// Auth token for your client view and batch endpoints, if any.</span>

<span class="hljs-attr">dataLayerAuth</span>: <span class="hljs-string">'2'</span>,

});

</span><span class="hljs-tag"></<span class="hljs-name">script</span>></span></code></pre>

<h2>🚗 Render UI</h2>

</a>

<p>Use <code>subscribe()</code> to open standing queries. Replicache fires <code>onData</code> whenever the result of the query changes, either because of local changes or sync.</p>

<pre><code class="language-js">rep.subscribe(

<span class="hljs-keyword">async</span> tx => {

<span class="hljs-keyword">return</span> <span class="hljs-keyword">await</span> toArray(tx.scan({<span class="hljs-attr">prefix</span>: <span class="hljs-string">'/todo/'</span>}));

{

<span class="hljs-attr">onData</span>: <span class="hljs-function"><span class="hljs-params">result</span> =></span> {

<span class="hljs-comment">// Using lit-html, but the principle is the same in any UI framework.</span>

<span class="hljs-comment">// See https://github.com/rocicorp/replicache-sdk-js/tree/master/sample/cal</span>

<span class="hljs-comment">// for an example using React.</span>

<span class="hljs-keyword">const</span> toggle = <span class="hljs-function"><span class="hljs-params">complete</span> =></span>

html`<span class="xml"><span class="hljs-tag"><<span class="hljs-name">td</span>></span><span class="hljs-tag"><<span class="hljs-name">input</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"checkbox"</span> <span class="hljs-attr">.checked</span>=</span></span><span class="hljs-subst">${complete}</span><span class="xml"><span class="hljs-tag"> /></span><span class="hljs-tag"></<span class="hljs-name">td</span>></span>`</span>;

<span class="hljs-keyword">const</span> title = <span class="hljs-function"><span class="hljs-params">text</span> =></span> html`<span class="xml"><span class="hljs-tag"><<span class="hljs-name">td</span>></span></span><span class="hljs-subst">${text}</span><span class="xml"><span class="hljs-tag"></<span class="hljs-name">td</span>></span>`</span>;

<span class="hljs-keyword">const</span> row = <span class="hljs-function"><span class="hljs-params">todo</span> =></span>

html`<span class="xml"><span class="hljs-tag"><<span class="hljs-name">tr</span>></span>

</span><span class="hljs-subst">${toggle(todo.complete)}</span><span class="hljs-subst">${title(todo.text)}</span><span class="xml">

<span class="hljs-tag"></<span class="hljs-name">tr</span>></span>`</span>;

render(

html`<span class="xml"><span class="hljs-tag"><<span class="hljs-name">table</span>></span>

</span><span class="hljs-subst">${result.map(row)}</span><span class="xml">

<span class="hljs-tag"></<span class="hljs-name">table</span>></span>`</span>,

<span class="hljs-built_in">document</span>.body,

);

);</code></pre>

<h2>🏎 Mutate Data</h2>

</a>

<p>Register client-side <em>mutators</em> using <code>register()</code>.</p>

<p>Mutators run completely locally, without waiting on the server — online, offline, whatever! A record of the mutation is queued and sent to your service's batch endpoint when possible.</p>

<p>Replicache also invokes mutators itself, during sync, to replay unacknowledged changes on top of newly received server state.</p>

<pre><code class="language-js"><span class="hljs-keyword">const</span> updateTodo = rep.register(<span class="hljs-string">'updateTodo'</span>, <span class="hljs-keyword">async</span> (tx, {id, complete}) => {

<span class="hljs-keyword">const</span> key = <span class="hljs-string">`/todo/<span class="hljs-su E470 bst">${id}</span>`</span>;

<span class="hljs-keyword">const</span> todo = <span class="hljs-keyword">await</span> tx.get(key);

todo.complete = complete;

<span class="hljs-keyword">await</span> tx.put(key, todo);

});

<span class="hljs-keyword">const</span> handleCheckbox = <span class="hljs-keyword">async</span> (id, e) => {

<span class="hljs-keyword">await</span> updateTodo({id, <span class="hljs-attr">complete</span>: e.srcElement.checked});

};</code></pre>

</a>

<ul>

<li>We recommend <a href="https://stackoverflow.com/questions/5327955/how-to-make-google-chrome-javascript-console-persistent">enabling console persistence</a> while developing replicache-enabled apps to make debugging easier.</li>

<li>Remember that data changes can happen "underneath" you and cause <code>subscribe()</code> to re-fire at any time. These changes can come from the server or from a different tab. If your UI is not reactive (driven solely by the data model) you need to take extra steps to ensure the UI is in sync with the data.</li>

</ul>

<h2>🚀 Next Steps</h2>

</a>

<p>That's it! You've built a fully-functioning offline-first todo app against our sample backend. What will you do next?</p>

<ul>

<li><a href="https://github.com/rocicorp/replicache-sdk-js/tree/master/sample/lit-todo">Check out the full version of this sample</a></li>

<li><a href="https://github.com/rocicorp/replicache#server-side">Learn how to add Replicache support to your own backend service</a></li>

<li><a href="https://github.com/rocicorp/replicache-sdk-js/tree/master/sample/cal">Check out the richer React/Babel/GCal sample</a></li>

<li><a href="https://replicache-sdk-js.now.sh/">Browse the full JS documentation</a></li>

</ul>

</div>

<ul>

<a href="globals.html"><em>Globals</em></a>

</li>

</ul>

</nav>

<a href="classes/repmwasminvoker.html" class="tsd-kind-icon">REPMWasm<wbr>Invoker</a>

</li>

<a href="classes/replicache.html" class="tsd-kind-icon">Replicache</a>

</li>

<a href="classes/scanresult.html" class="tsd-kind-icon">Scan<wbr>Result</a>

</li>

<a href="classes/transactionclosederror.html" class="tsd-kind-icon">Transaction<wbr>Closed<wbr>Error</a>

</li>

<a href="interfaces/repminvoke.html" class="tsd-kind-icon">REPMInvoke</a>

</li>

<a href="interfaces/readtransaction.html" class="tsd-kind-icon">Read<wbr>Transaction</a>

</li>

<a href="interfaces/writetransaction.html" class="tsd-kind-icon">Write<wbr>Transaction</a>

</li>

<a href="globals.html#invoker" class="tsd-kind-icon">Invoker</a>

</li>

<a href="globals.html#keytypeforscanoptions" class="tsd-kind-icon">Key<wbr>Type<wbr>For<wbr>Scan<wbr>Options</a>

</li>

<a href="globals.html#mutator" class="tsd-kind-icon">Mutator</a>

</li>

<a href="globals.html#scanindexoptions" class="tsd-kind-icon">Scan<wbr>Index<wbr>Options</a>

</li>

<a href="globals.html#scannoindexoptions" class="tsd-kind-icon">Scan<wbr>NoIndex<wbr>Options</a>

</li>

<a href="globals.html#scanoptionindexedstartkey" class="tsd-kind-icon">Scan<wbr>Option<wbr>Indexed<wbr>Start<wbr>Key</a>

</li>

<a href="globals.html#scanoptions" class="tsd-kind-icon">Scan<wbr>Options</a>

</li>

</ul>

</nav>

</div>

<h2>Legend</h2>

<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>

<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>

<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>

<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>

<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>

<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>

<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>

<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>

</footer>

<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>

</div>

</body>

</html>

FilesExpand file tree

index.html

Latest commit

History

index.html

File metadata and controls