ReactiveX / ReactiveX/rxjs

bindCallback incomplete example in docs app

Open
#5,069 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
TypeScript
Stars
31.7k
Forks
3k
PR merge metrics
No merged PRs in 30d

Description

Documentation Related To Component:

bindCallback

Please check those that apply
  • typo
  • documentation doesn't exist
  • documentation needs clarification
  • error(s) in example
  • needs example
Description Of The Issue

For example Receive an array of arguments passed to a callback to work someFunction callback needs to be called at the end at least once.

So the full correct example IMO should be:

import { bindCallback } from 'rxjs';
 
const someFunction = (a, b, c) => {
  console.log(a); // 5
  console.log(b); // 'some string'
  console.log(c); // {someProperty: 'someValue'}
};
 
const boundSomeFunction = bindCallback(someFunction);
boundSomeFunction().subscribe(values => {
  console.log(values) // [5, 'some string', {someProperty: 'someValue'}]
});

someFunction(5, 'some string', {someProperty: 'someValue'}); // --> missing line

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

Open the linked bindCallback documentation section in the RxJS docs app and inspect the example for receiving an array of callback arguments. Run the example or docs app to confirm its current behavior, then verify that the displayed example is complete and produces the documented array of values.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.