Skip to content

Commit

Permalink
Improve consistency of code examples (#51)
Browse files Browse the repository at this point in the history
- no semicolons
- two spaces indentation
- some examples would not run as-is
  • Loading branch information
CodeWitchBella committed Nov 13, 2023
1 parent 46f9186 commit 7b3b589
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
12 changes: 6 additions & 6 deletions docs/repositories/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

The entry point for an `automerge-repo` based application is to create a [`Repo`](https://automerge.org/automerge-repo/classes/_automerge_automerge_repo.Repo.html), passing it some form of [`StorageAdapter`](https://automerge.org/automerge-repo/classes/_automerge_automerge_repo.StorageAdapter.html) - which knows how to save data locally - and zero or more [`NetworkAdapter`](https://automerge.org/automerge-repo/classes/_automerge_automerge_repo.NetworkAdapter.html)s, which know how to talk to other peers running `automerge-repo`.

For example, this snippet creates a `Repo` which listens for websocket connections and stores data in the local file system:
For example, this snippet creates a `Repo` which listens for websocket connections and stores data in the local file system:

```typescript
import { Repo } from "@automerge/automerge-repo"
import { WebSocketServer } from "ws"
import { NodeWSServerAdapter } from "@automerge/automerge-repo-network-websocket"
import { NodeFSStorageAdapter } from "@automerge/automerge-repo-storage-nodefs"

const socket = new WebSocketServer({ noServer: true })
const wss = new WebSocketServer({ noServer: true })

const repo = new Repo({
network: [new NodeWSServerAdapter(socket)],
storage: new NodeFSStorageAdapter(dir),
network: [new NodeWSServerAdapter(wss)],
storage: new NodeFSStorageAdapter(dir),
})
```

Expand All @@ -28,8 +28,8 @@ let doc = repo.create()
// Make a change ourselves and send that to everyone else
doc.change(d => d.text = "hello world")
// Listen for changes from other peers
doc.on("change", {doc} => {
console.log("new text is ", doc.text)
doc.on("change", ({ doc }) => {
console.log("new text is ", doc.text)
})
```

Expand Down
16 changes: 8 additions & 8 deletions docs/repositories/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ The server side of the adapter is [`NodeWSServerAdapter`](https://automerge.org/
import { WebSocketServer } from "ws"
import { NodeWSServerAdapter } from "@automerge/automerge-repo-network-websocket"
const wss = new WebSocketServer({ port: 8080 });
const adapter = new NodeWSServerAdapter(this.#socket)
const wss = new WebSocketServer({ port: 8080 })
const adapter = new NodeWSServerAdapter(wss)
```

#### Usage with `express`
Expand All @@ -34,12 +34,12 @@ import { WebSocketServer } from "ws"
import { NodeWSServerAdapter } from "@automerge/automerge-repo-network-websocket"
import express from "express"
const wss = new WebSocketServer({ noServer: true });
const wss = new WebSocketServer({ noServer: true })
const server = express()
server.on("upgrade", (request, socket, head) => {
wss.handleUpgrade(request, socket, head, (socket) => {
wss.emit("connection", socket, request)
})
wss.handleUpgrade(request, socket, head, (socket) => {
wss.emit("connection", socket, request)
})
})
const adapter = new NodeWSServerAdapter(wss)
server.listen(8080)
Expand Down Expand Up @@ -68,10 +68,10 @@ const rightToLeft = new MessageChannelNetworkAdapter(rightToLeft)
const leftToRight = new MessageChannelNetworkAdapter(leftToRight)
const left = new Repo({
network: [leftToRight],
network: [leftToRight],
})
const right = new Repo({
network: [rightToLeft],
network: [rightToLeft],
})
```

Expand Down

0 comments on commit 7b3b589

Please sign in to comment.