Published 📅: ....
Last modified 📝: ....
Share this post on BlueskySee 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 actualValue = jsonObject as MyDesiredJSONType;It felt a bit icky to me to not only copy and paste that across the codebase, but also worry about trying to remind others contributing to the code to do the same thing when they want to import the JSON value.
I instead found a neat little alternative approach that works pretty well, using module declarations and import maps (I've written about import maps before in this blog post)!
The trick is to do the following:
<some-filename>.d.ts file (I've opted to call mine local-types.d.ts since I have a few other things in there too)declare module "#<some-identifier>" {
import type { MyDesiredJSONType } from "./src/types";
let jsonObject: MyDesiredJSONType;
export default jsonObject;
}I recommend prefixing the identifier with a special character, specifically #. This helps to identify it as a local module specifier (as opposed to @ which might map to a scoped 3rd party package), and easily stands out to others reading the codebase!
Finally, and importantly, configure your import maps / paths configs:
package.json imports recordtsconfig.json paths recordHere's an example configuration within a package.json file:
{
"imports": {
"#some-identifier": "./src/some-json-file.json"
}
}and here's an example configuration within a tsconfig.json file:
{
"compilerOptions": {
"paths": {
"#some-identifier": ["./src/some-json-file.json"]
}
}
}Note! Just because I'm using a JSON module as an example here doesn't mean this strategy only works with JSON files - you can do this for any kind of file type!
Thats it! This should then let TypeScript use that declared module type whenever you import from this new identifier!
Matt Hamlin
@matthamlin.me
A quick tip outlining how to provide specific TypeScript type definitions for a local module!
Loading...
Published: ....
Have you ever wanted to create a class in JavaScript or TypeScript but also have the initialization be async? Here's a quick tip on a pattern that I've used in the past!
Published: ....
A quick look at a small but powerful pattern I've been leveraging as of late!
Published: ....
A proposal for a minimal variant of TypeScript!
Loading comments...
Published: ....
A quick introduction to my new side project, hohoro. An incremental JS/TS library build tool!
Published: ....
Are we reinventing the wheel when it comes to onboarding new AI agents to a codebase, when we already have primitives available for onboarding humans?
Published: ....
Have you ever found the need to change the image you render on a web page based on the current preferred color scheme of your theme?
Published: ....
Have you ever wanted to create a class in JavaScript or TypeScript but also have the initialization be async? Here's a quick tip on a pattern that I've used in the past!
Published: ....
Are we reinventing the wheel when it comes to onboarding new AI agents to a codebase, when we already have primitives available for onboarding humans?
Published: ....
Published: ....
Published: ....
I recently launched a rewrite and redesign of this personal website, I figured I'd talk a bit about the changes and new features that I added along the way!
Published: ....
A few thoughts on what to do after you launch a new project
Published: ....
Have you ever found the need to change the image you render on a web page based on the current preferred color scheme of your theme?
Published: ....
A quick tip for creating roundup or summary notes based on other notes in Obsidian using the Dataview plugin!