Skip to content

Commit

Permalink
fix: don't document onceWriteDoc (#25)
Browse files Browse the repository at this point in the history
`indexer.onceWriteDoc` was removed in
8caaf6a (#21). This removes its
mention in the readme.

`git grep -i onceWriteDoc` shows no remaining references to this method
outside the changelog.
  • Loading branch information
EvanHahn committed Jan 22, 2024
1 parent 6b34678 commit 36c3333
Showing 1 changed file with 0 additions and 4 deletions.
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,6 @@ The name of the table for storing backlinks (used internally for indexing).

Index an array of documents. Documents can be in any order. Documents must have an `id` property, a `version` property that is unique, and a `links` property which is an array of version ids for the documents parent(s).

### indexer.onceWriteDoc(version, listener)

Set a listener for a doc at a specific version. Useful for performing an action based on completion of indexing of a document.

### indexer.deleteAll()

Delete all documents and backlinks. Useful if you want to reset the index.
Expand Down

0 comments on commit 36c3333

Please sign in to comment.