bindCallback incomplete example in docs app

[danielcaldas]

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

[cartant]

That particular example seems incorrect, to me. someFunction doesn't even take a callback, so I don't see how it can be used with bindCallback. IMO, the example should be removed.

[danielcaldas]

Interesting enough @cartant, the above example logs the expected values. Then, maybe the example does not depicts the correct usage of bindCallback, or?

[cartant]

Well, it'll log it because the function is called, but there is no callback, so it's pointless and not a good example.

[danielcaldas]

Ah true, then it's pointless. I agree you should just remove it.

[roddc]

import { bindCallback } from 'rxjs';

const someFunction = (cb) => {
  cb(5, 'some string', {someProperty: 'someValue'})
};

const boundSomeFunction = bindCallback(someFunction);
boundSomeFunction(12, 10).subscribe(values => {
  console.log(values); // [22, 2]
}); 

The example is wrong