share / share/sharedb

Is there any way to get a list of collections?

Open
#298 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
6.5k
Forks
456
Avg merge
1d 5h
Merged PRs (30d)
5

Description

Hey there -- I'm considering using ShareDB in earnest, but to be honest I'm finding the documentation (as in the readme) terse to the point of being unhelpful, and digging into the code proper it's not very accessible...

I guess the biggest question for me is, is there any abstraction over collections? Can you get a list of them? Can you perform any meaningful operations on them (watching for document changes, etc)?

Would love to know if there's some kind of documentation somewhere I'm missing :)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README and the collection-related entry points in the ShareDB code, since the issue names no specific files or tests. Document whether collections can be listed, watched, or otherwise operated on, and point readers to the relevant APIs or explain the limitation clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
databases, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.