lit / lit/lit.dev

[docs/task] Document other task options / include whole API

Open
#1,296 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
142
Forks
230
PR merge metrics
No merged PRs in 30d

Description

https://lit.dev/docs/data/task/#usage has no mention of other available task options like: `initialValue`, `argsEqual`, `onComplete`, and `onError`.

Since we don't have an API docs section for this package, we should maybe provide the whole API here even if we need to construct it manually like we do for Context.

Contributor guide

Open the contributing guide

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 task documentation at https://lit.dev/docs/data/task/#usage and inspect how the existing usage section describes task options. Document initialValue, argsEqual, onComplete, and onError, and determine whether the page should include the package's complete API; done means the available options are covered accurately in the documentation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.