Skip to content

Add missing documentation about the Subscribe API #1075

@jarifibrahim

Description

@jarifibrahim

The subscribe API
https://github.com/dgraph-io/badger/blob/f50343ff404d8198df6dc83755ec2eab863d5ff2/db.go#L1510-L1516

was added in badger via 26128a7 but there is no documentation about it. We should also have an example of how to use the Subscribe API.

https://github.com/dgraph-io/badger/blob/f50343ff404d8198df6dc83755ec2eab863d5ff2/db_test.go#L1939-L1948 can be used for inspiration.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/documentationDocumentation related issues.kind/enhancementSomething could be better.priority/P3Low priority, something to be done once everything else is fixed.status/acceptedWe accept to investigate or work on it.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions