TypeScript Support

[willsmanley]

It would be nice to have a @types/dynalite for this lib

[leaumar]

Our project uses this, perhaps a good starting point? I don't know dynalite enough myself to kickstart this.

declare module 'dynalite' {
  import { Server } from 'http';

  interface DynaliteServer {
    listen: (callback: (error: Error | undefined) => void) => Server;
  }

  interface DynaliteOptions {
    createTableMs?: number;
    path?: string;
  }

  export default function dynalite(options?: DynaliteOptions): DynaliteServer;
}

I do wish this TS support gets made soon, it's now the only hurdle (after dozens, and dozens, and dozens before it...) between our project and yarn2+pnp. 😅

[reconbot]

@ryanblock I'm making some types right now for a project - would you rather them contributed to @types/dynalite or to this project directly as jsdoc comments?

[ryanblock]

@reconbot hey man! I don't have a personal preference, only that I am not maintaining them, heh! JSDoc has proved to be limiting and didn't quite work out when used in some other projects of late, although I guess if all we're doing is adding them to the index.js file, that's probably super straightforward, no?

[reconbot]

Yea JSDOC works out for this project. The silly bit is that we pass the options object to the https.createServer() to pass the included ssl keys (which are expired btw) but don't pass it to http.createServer() So you could mess with the server options but only if you use ssl.

[ryanblock]

Oh jeez, those keys are expired eh? Iirc Michael mentioned they were a huge thorn in his side and that he kind of wished he hadn't added https support. I'm going to propose dropping it, or at least dropping use of our own keys (e.g. if you want to use that feature, you have to supply your own keys). We've looked at https in Sandbox-land time and time again, and every time we arrive at the conclusion that it's way more trouble than it's worth, especially given the local dev context.

[reconbot]

💯 I fully support removing keys. I was going to create an issue about it but figured I was procrastinating on my real work and let it be