Flowtype Libdefs：如何在koa-router中导入koa的类型？

I’ve run into this exact issue before—trying to reference types from one libdef in another can feel tricky at first, but there’s a straightforward fix once you understand how Flow handles module declarations in libdefs.

The Core Problem #

When you added import type { Middleware } from 'koa'; inside your declare module block, Flow might have been confused about resolving the Koa type, or your export syntax might have mismatched what koa-router actually exposes. Let’s fix both.

Step 1: Ensure Koa’s LibDef is Available #

First, make sure you have the official Koa libdef set up:

• If using flow-typed: Run flow-typed install koa@<your-koa-version> to pull the correct type definitions.
• If using a custom libdef, ensure it’s in a directory Flow recognizes (like flow-typed/ or a folder listed in your .flowconfig under [libs]).

Step 2: Correct LibDef Syntax #

Here’s the working version of your koa-router libdef. The key tweaks are:

• Keeping the import type inside the declare module block (supported in Flow 0.98+).
• Exporting the Router class directly instead of typeof Router (since koa-router’s default export is the class constructor itself).

declare module "koa-router" {
  // Import the Middleware type directly from Koa's libdef
  import type { Middleware } from 'koa';

  declare class Router {
    // Use the imported Middleware type for handler arguments
    get(route: string, handler: Middleware): this;
    // Add other methods like post/put/delete as needed
    post(route: string, handler: Middleware): this;
    put(route: string, handler: Middleware): this;
  }

  // Export the Router class to match koa-router's API
  declare export default Router;
}

Step 3: Verify Your Flow Config #

Double-check your .flowconfig to ensure the folder with your custom koa-router libdef is included in the [libs] section. For example:

[libs]
flow-typed/
src/custom-defs/

Alternative for Older Flow Versions #

If you’re stuck on a Flow version before 0.98 that doesn’t support import type inside declare module blocks, use the $FlowImportType utility to reference the Middleware type:

declare module "koa-router" {
  // Import the Middleware type using Flow's legacy import utility
  type Middleware = $FlowImportType<"koa", "Middleware">;

  declare class Router {
    get(route: string, handler: Middleware): this;
  }

  declare export default Router;
}

Testing It Out #

Once you’ve updated the libdef, run flow check to confirm no errors pop up. You should now be able to use the Router class with Koa’s Middleware type seamlessly.

内容的提问来源于stack exchange，提问作者Saad