Skip to content

docs: update README to specify TypeScript lib requirement #788

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

Merged
merged 1 commit into from
Jul 18, 2025
Merged

docs: update README to specify TypeScript lib requirement #788

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ Install the package:
npm install angular-ecmascript-intl --save
```

This package requires TypeScript with a lib setting of ES2021 or later.
Older lib targets (e.g., ES2020 or below) are not supported and may cause
type errors or missing type definitions. Make sure your `tsconfig.json` includes
`"lib": ["ES2021"]` (or a newer standard such as ES2022) to ensure full compatibility.

Import the pipes individually as per usage, or import the `IntlModule` to import all pipes at once.

By default, all pipes will use the browser default locale.
Expand Down