Open
Description
An interesting use-case came up in the TypeDoc repo (TypeStrong/typedoc#858). Would it be reasonable to define the following as a function rather than a variable? JSDoc users can use @function
but from discussions in #8 I don't know if that would be a good thing to carryover.
/**
* Promisified version of fs.writeFile().
* @function writeFileAsync
*/
export const writeFileAsync: Function = util.promisify(fs.writeFile);
A similar use case is instance methods. I know that tslint has made changes to view these the same as methods for the purpose of grouping properties and methods.
class Foo {
constuctor(events: EventService) {
events.on('someevent', this.bar);
}
/**
* This acts like a method and can be passed as a callback without losing context of `this`.
* @param param - new value of prop
*/
bar = (param: String) => {
console.log('Am I a method?');
this.prop = param;
}
}