mobxjs / mobxjs/mobx-utils

Question about naming and interfaces

Open
#95 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

PR welcome!
Dominant language
TypeScript
Stars
1.2k
Forks
130
PR merge metrics
No merged PRs in 30d

Description

I was just curious what was the reasoning behind .value from fromPromise and current() from fromResources and lazyObservable as those names don't appear anywhere else in mobx.

In RxJs most of the return values are Rx.Observable. Coming from there, one would expect these to implement some common interface like boxed values (.get). What's the equivalent predictable interface for the return values inmobx and mobx-utils?

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

Review the documented APIs for fromPromise, fromResources, and lazyObservable, then compare their return-value access patterns with boxed values and Rx.Observable. Done means documenting the intended interface and explaining why these names and accessors differ.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.