Skip to content

API Changes and Deprecation List for V4Β #909

@cowboyd

Description

@cowboyd

Certain APIs are going to need to change, although not very much, for v4. We should make a list of them.

  • call() This is very overused for noting scope, and also for evaluating promise. We are going to deprecate the bare promise

    • add notes on the what is changing about call(), and how to upgrade
    • add scoped() to V3. It will be just an alias to call(). One option for upgrade. Upgrade would involve replace call() -> scope() then fix TS errors.
  • Scope#run -> run(op, { scope })

    • ideally replace Scope#run -> Scope#spawn
  • action(): Action will become more like the promise constructor and will not take an operation function, but instead will take a simple function that receives a resolver to be called when the effect resolves. It is more a general effect resolver than anything else.

  • update action jsdocs on the website to be curret

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions