Skip to content

Fix typo in @atproto/sync README from 'handleEvt' to 'handleEvent' #4696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lukeacl wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typo in @atproto/sync README from 'handleEvt' to 'handleEvent' #4696

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/sync/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ TypeScript library for syncing data from the [atproto](https://atproto.com) netw

The firehose class will spin up a websocket connection to `com.atproto.sync.subscribeRepos` on a given repo host (by default the Relay run by Bluesky).

Each event will be parsed, authenticated, and then passed on to the supplied `handleEvt` which can handle indexing.
Each event will be parsed, authenticated, and then passed on to the supplied `handleEvent` which can handle indexing.

On `Commit` events, the firehose will verify signatures and repo proofs to ensure that the event is authentic. This can be disabled with the `unauthenticatedCommits` flag. Similarly on `Identity` events, the firehose will fetch the latest DID document for the repo and do bidirectional verification on the associated handle. This can be disabled with the `unauthenticatedHandles` flag.

Expand All @@ -27,7 +27,7 @@ const idResolver = new IdResolver()
const firehose = new Firehose({
idResolver,
service: 'wss://bsky.network',
handleEvt: async (evt) => {
handleEvent: async (evt) => {
if (evt.event === 'identity') {
// ...
} else if (evt.event === 'account') {
Expand Down Expand Up @@ -69,7 +69,7 @@ const firehose = new Firehose({
idResolver,
runner,
service: 'wss://bsky.network',
handleEvt: async (evt) => {
handleEvent: async (evt) => {
// ...
},
onError: (err) => {
Expand Down
Loading