Quick Tip - Specific Local Module Declarations

Published ....
Last modified ....

Share this post on Bluesky See discussion on Bluesky

I've been working in a codebase lately that uses a shared module across a few different files - in my case the module is a JSON file that I'm importing and I wanted to enforce consistent types for the value when it was imported across the codebase.

As far as I can tell the recommended solution looked something like this:

import jsonObject from "./some/path/to/the/file.json";
import type { MyDesiredJSONType } from "./some-types";

let

declare module "#<some-identifier>" {
  import type { MyDesiredJSONType } from "./src/types";
  let jsonObject: MyDesiredJSONType;
  export default jsonObject;
}

{
  "imports": {
    "#some-identifier": "./src/some-json-file.json"
  }
}

{
  "compilerOptions": {
    "paths": {
      "#some-identifier": ["./src/some-json-file.json"]
    }
  }
}

Quick Tip - Specific Local Module Declarations

Quick Tip - Specific Local Module Declarations

Tags:

Bluesky Post and Comments:

Related Posts

TypeScript

Web Development

Tip

Development

Node.js

Related Posts

TypeScript

Web Development

Tip

Development

Node.js

Quick Tip - Specific Local Module Declarations