Skip to content

Update README to only use @types/meteor DT types as fallback #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+19 −1
Open

Update README to only use @types/meteor DT types as fallback #20

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c87a1b4
Update README.md
perbergland Jul 22, 2024
10a1c6e
fix links
perbergland Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,32 @@ meteor add zodern:types
"preserveSymlinks": true,
"paths": {
"meteor/*": [
"node_modules/@types/meteor/*",
".meteor/local/types/packages.d.ts"
]
}
}
}
```

At the time of writing (2024-07-22), there are some Meteor core packages that don’t exist/cannot be imported. For those types, you can still import types from the DefinitelyTyped npm package by adding paths entries in tsconfig.json.

```jsonc
{
"compilerOptions": {
"preserveSymlinks": true,
"paths": {
// Workaround for https://github.com/zodern/meteor-types/issues/10
"meteor/react-meteor-data": [
"./node_modules/@types/meteor/react-meteor-data.d.ts"
],
// Workaround for https://github.com/meteor/meteor/issues/13240
"meteor/tools": ["./node_modules/@types/meteor/tools.d.ts"],
"meteor/*": ["./.meteor/local/types/packages.d.ts"]
},
}
}
```

`zodern:types` stores the type definitions from packages in your app's `.meteor/local/types` folder.
If your tsconfig has `exclude` configured, make sure the exclude rules do not exclude `.meteor/local/types`.

Expand Down