WatchMessage Type Definition Incomplete

Open
#117 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
api, documentation

Research direction

Start with the linked WatchMessage type definition in the API documentation and inspect how its type field is currently described. Document the concrete enum shape and values supported by filesystem watching; the issue is done when users can determine the possible watch message types from the page.

Written by the indexing model from the issue text.

Description

Hey team,

We are looking to use Sprites programmatically for a few production use cases. To help with our evaluation, can you please complete the WatchMessage type definition? Specifically, type appears to be an enum with undefined shape. We would love to see how watch filesystem works in production!

Dominant language
TypeScript
Stars
51
Forks
4
Avg merge
23h 57m
Merged PRs (30d)
12

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.

More from superfly/sprites-docs

All issues in superfly/sprites-docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.