Expose types #5
Expose types #5
Conversation
jkrems
force-pushed
the
jkrems/feature/master/types
branch
from
bead594
to
9383ded
Compare
| @@ -22,6 +26,9 @@ function toNumber(value) { | |||
| * @param {Options} options | |||
| */ | |||
| async function start(ctx, options) { | |||
| await ctx.initialize(); | |||
| await ctx.configure(); | |||
There was a problem hiding this comment.
These were mostly added so that we "document" the public interface. E.g. my initial typings were missing these methods and I wanted to make sure that would be caught.
| @@ -254,7 +245,11 @@ class Scope { | |||
| * @returns {Injector} | |||
| */ | |||
| createInjector(init, parent) { | |||
| return new Injector(this, init, parent); | |||
| return new Injector( | |||
| /** @type {import('../typedefs').Scope} */ (this), | |||
There was a problem hiding this comment.
if you preceded class Scope { with /** @type {typeof import('../typedefs').Scope} */ would that make it so you didn't have to cast all these?
There was a problem hiding this comment.
Can't find a way around this. Tried different variations but inside of the class body those two are considered different types. :( There may be some magical combination of interfaces and factory functions that would make this work but it would make the code a bit harder to follow.
lib/nilo.js
Outdated
| exports.App = /** @type {typeof import('./typedefs').App} */ (require('./app')); | ||
| exports.Project = /** @type {typeof import('./typedefs').Project} */ (require('./project')); | ||
| exports.Registry = /** @type {typeof import('./typedefs').Registry} */ (require('./registry')); | ||
| exports.main = /** @type {typeof import('./typedefs').main} */ (require('./main')); |
There was a problem hiding this comment.
if these files imported their types from typedefs in their export location, would that be possible/cleaner?
There was a problem hiding this comment.
Yep! And I think it makes everything look a bit nicer. Good idea!
This allows users of
niloto get the proper autocomplete etc..