Allow introspection of CAF-wrapped generators #26
Conversation
Add 2 properties to functions that are CAF-wrapped generators: * cafFn.isCAF - true. So the user can detect they're dealing with a function that was produced by CAF. * cafFn.generatorName - string. The name of the original generator function. "anonymous" if the original generator was an anonymous generator. See the tests added in this diff for examples.
| ); | ||
| Object.defineProperty( | ||
| instance, | ||
| "generatorName", |
There was a problem hiding this comment.
Instead of generatorName, what would you think about origName? I'm a little concerned that "generator" is a bit too leaky of a description.
|
|
||
| return instance; | ||
|
|
||
| function instance(tokenOrSignal,...args){ |
There was a problem hiding this comment.
if we don't change the name property of the function instance, it won't be obvious in console debugging that such a function is CAF-wrapped. it might be easy to miss that fact in your debugging if you don't think to look for the isCAF boolean.
| => true | ||
| console.log(namedFn.generatorName) | ||
| => "namedGenerator" | ||
| console.log(namedFn.isCAF); |
There was a problem hiding this comment.
here I think you mean anonymousFn.
| => "namedGenerator" | ||
| console.log(namedFn.isCAF); | ||
| => true | ||
| console.log(namedFn.generatorName) |
| @@ -28,7 +28,22 @@ module.exports.signalAll = signalAll; | |||
|
|
|||
|
|
|||
| function CAF(generatorFn) { | |||
| return function instance(tokenOrSignal,...args){ | |||
| // allow users to introspect to understand if the function they're dealing | |||
There was a problem hiding this comment.
We should also apply the same additions/changes to CAG (in cag.js) as we do here.
Could be isCAG instead of isCAF, but then everywhere I think users might have to check isCAF || isCAG. That might get annoying.
Maybe instead, we could change from isCAF to something generic like isCancelable (or something easier to type and not misspell!), and then have another flag that distinguishes CAF vs CAG.
Thoughts?
Add 2 properties to functions that are CAF-wrapped generators:
function that was produced by CAF.
function. "anonymous" if the original generator was an anonymous
generator.
See the tests added in this diff for examples.