[📖] useConstant is not documented
Open
Nobody has claimed this yet.
docs
PR welcomed
V2
- Dominant language
- TypeScript
- Stars
- 22.1k
- Forks
- 1.4k
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 52
Description
Suggestion
V2 code:
/**
* Stores a value which is retained for the lifetime of the component. Subsequent calls to
* `useConstant` will always return the first value given.
*
* If the value is a function, the function is invoked once to calculate the actual value.
*
* @public
*/
export const useConstant = <T>(value: (() => T) | T): T => {
const { val, set } = useSequentialScope<T>();
if (val != null) {
return val;
}
// Note: We are not using `invoke` here because we don't want to clear the context
value = isFunction(value) && !isQwikComponent(value) ? value() : value;
return set(value as T);
};
Note: in V1 it's marked as deprecated but not in V2.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the V2 useConstant entry point and compare it with the V1 API documentation, where it is marked deprecated. Document the V2 API and clarify its deprecation status; done when useConstant is covered consistently with the project's other public APIs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100