skills/angular__angular
1
0
Fork 0
mirror of https://github.com/angular/angular.git synced 2026-09-14 13:54:52 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
dfe7be4d2a700c5a2a22f8060358078518166b08
angular__angular/goldens/public-api/common/errors.api.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

84 lines
2.3 KiB
Markdown
Raw Normal View History

build: migrate to new toolchain usage for api goldens (#62688) Migrate api golden usage to be based on rules_js toolchain implementation PR Close #62688
2025-07-17 17:31:38 +00:00
## API Report File for "common_errors"
ci: add golden files for runtime error codes (#44677) Runtime error codes in the Core, Common and Forms packages were not included into the `public-api` group reviews. This commit creates the necessary golden files to keep track of further changes in the runtime codes. This is a followup from https://github.com/angular/angular/pull/44398#issuecomment-1006910976. PR Close #44677
2022-01-10 14:09:41 -08:00
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
// @public
export const enum RuntimeErrorCode {
fix(common): use === operator to match NgSwitch cases (#51504) This change adjust the equality comparator used by NgSwitch - now it defaults to === from previously used ==. This change is based on the following reasoning: - align behaviour with the built-in switch block); - improve performance (avoid type coercion); - enable better type-checking. BREAKING CHANGE: the NgSwitch directive now defaults to the === equality operator, migrating from the previously used ==. NgSwitch expressions and / or individual condition values need adjusting to this stricter equality check. The added warning message should help pinpointing NgSwitch usages where adjustements are needed. Fixes #33873 PR Close #51504
2023-08-25 11:17:11 -07:00
// (undocumented)
EQUALITY_NG_SWITCH_DIFFERENCE = 2001,
feat(common): add Image directive skeleton (#45627) (#47082) This commit adds Image directive skeleton as well as a set of basic tests. PR Close #47082
2022-04-15 16:58:40 -07:00
// (undocumented)
refactor(common): drop error messages in production (#60415) Drops more error messages in production. PR Close #60415
2025-03-17 11:18:13 +02:00
INVALID_DIGIT_INFO = 2306,
// (undocumented)
feat(common): support custom srcset attributes in NgOptimizedImage (#47082) This commit adds a `rawSrcset` attribute as a replacement for the `srcset` attribute. The `srcset` attribute cannot be set statically on the image directive because it would cause images to start downloading before the "loading" attribute could be set to "lazy". Changing the name to `rawSrcset` allows the directive to control the timing of image loading. It also makes it possible to support custom loaders for `srcset` file names. Rather than having to repeat the image origin for each image, the existing `rawSrc` value and image loader can be composed to generate each full URL string. The developer must only provide the necessary widths for the `srcset`. For example, the developer might write: ```markup <img rawSrc="hermes.jpg" rawSrcset="100w, 200w" ... /> ``` with a loader like: ```js const loader = (config) => `path/${config.src}?w=${config.width}`; ``` and the img tag will ultimately be set up as something like: ```markup <img src="path/hermes.jpg?w=100" srcset="path/hermes.jpg?w=100 100w, path/hermes.jpg?w=200 200w" .../> ``` PR Close #47082
2022-05-11 16:38:31 -07:00
INVALID_INPUT = 2952,
refactor(common): make the error messages tree shakable (#44663) Make Long error messages tree-shakable in the production build with error codes. fixes #40096 PR Close #44663
2022-01-08 14:48:47 +05:30
// (undocumented)
refactor(common): drop error messages in production (#60415) Drops more error messages in production. PR Close #60415
2025-03-17 11:18:13 +02:00
INVALID_INTEGER_LITERAL = 2305,
// (undocumented)
refactor(common): throw an error if an absolute URL is passed to Image Loaders (#47082) This commit updates the logic of Image Loaders to throw an error in case an absolute URL is provided an an input to the loader function. The loaders can construct URLs based on image paths relative to the bas URL configured for a loader. PR Close #47082
2022-06-14 15:12:56 -07:00
INVALID_LOADER_ARGUMENTS = 2959,
// (undocumented)
refactor(common): drop error messages in production (#60415) Drops more error messages in production. PR Close #60415
2025-03-17 11:18:13 +02:00
INVALID_NUMBER_OF_DIGITS_AFTER_FRACTION = 2307,
// (undocumented)
refactor(common): make the error messages tree shakable (#44663) Make Long error messages tree-shakable in the production build with error codes. fixes #40096 PR Close #44663
2022-01-08 14:48:47 +05:30
INVALID_PIPE_ARGUMENT = 2100,
ci: add golden files for runtime error codes (#44677) Runtime error codes in the Core, Common and Forms packages were not included into the `public-api` group reviews. This commit creates the necessary golden files to keep track of further changes in the runtime codes. This is a followup from https://github.com/angular/angular/pull/44398#issuecomment-1006910976. PR Close #44677
2022-01-10 14:09:41 -08:00
// (undocumented)
build: add a noDuplicateEnumValue rule (#63483) It caught several legitimate issues. In the cases I wasn't sure, I just disabled the rule. fixes #45843 PR Close #63483
2025-08-29 18:03:43 +02:00
INVALID_TO_DATE_CONVERSION = 2311,
refactor(common): drop error messages in production (#60242) Drops more error messages in production. PR Close #60242
2025-03-06 12:29:28 +02:00
// (undocumented)
feat(common): support custom srcset attributes in NgOptimizedImage (#47082) This commit adds a `rawSrcset` attribute as a replacement for the `srcset` attribute. The `srcset` attribute cannot be set statically on the image directive because it would cause images to start downloading before the "loading" attribute could be set to "lazy". Changing the name to `rawSrcset` allows the directive to control the timing of image loading. It also makes it possible to support custom loaders for `srcset` file names. Rather than having to repeat the image origin for each image, the existing `rawSrc` value and image loader can be composed to generate each full URL string. The developer must only provide the necessary widths for the `srcset`. For example, the developer might write: ```markup <img rawSrc="hermes.jpg" rawSrcset="100w, 200w" ... /> ``` with a loader like: ```js const loader = (config) => `path/${config.src}?w=${config.width}`; ``` and the img tag will ultimately be set up as something like: ```markup <img src="path/hermes.jpg?w=100" srcset="path/hermes.jpg?w=100 100w, path/hermes.jpg?w=200 200w" .../> ``` PR Close #47082
2022-05-11 16:38:31 -07:00
LCP_IMG_MISSING_PRIORITY = 2955,
test(common): add e2e tests for LCP check logic of the `NgOptimizedImage` directive (#47082) This commit adds e2e tests for the LCP check logic. Those tests are needed to verify the behavior in a real browser (vs relying on a Node environment). PR Close #47082
2022-05-12 16:52:06 -07:00
// (undocumented)
feat(common): Allow ngSrc to be changed post-init (#50683) Remove thrown error when ngSrc is modified after an NgOptimizedImage image is initialized PR Close #50683
2023-06-12 09:45:09 -07:00
LCP_IMG_NGSRC_MODIFIED = 2964,
// (undocumented)
refactor(common): drop error messages in production (#60415) Drops more error messages in production. PR Close #60415
2025-03-17 11:18:13 +02:00
LOCALE_DATA_UNDEFINED = 2304,
// (undocumented)
fix(common): warn if using supported CDN but not built-in loader (#47330) This commit adds a missing warning if the image directive detects that you're hosting your image on one of our supported image CDNs but you're not using the built-in loader for it. This excludes applications that are using a custom loader. PR Close #47330
2022-09-01 21:34:12 -06:00
MISSING_BUILTIN_LOADER = 2962,
// (undocumented)
refactor(common): drop error messages in production (#60415) Drops more error messages in production. PR Close #60415
2025-03-17 11:18:13 +02:00
MISSING_EXTRA_LOCALE_DATA_FOR_LOCALE = 2303,
// (undocumented)
feat(common): Add loaderParams attribute to NgOptimizedImage (#48907) Add a new loaderParams attribute, which can be used to send arbitrary data to a custom loader, allowing for greater control of image CDN features. PR Close #48907
2023-02-01 15:38:19 -08:00
MISSING_NECESSARY_LOADER = 2963,
fix(core): Updates error to use RuntimeError code (#46526) This updates the iterable differ error to use more up-to-date error codes. PR Close #46526
2022-06-27 13:04:15 -07:00
// (undocumented)
feat(common): Add loaderParams attribute to NgOptimizedImage (#48907) Add a new loaderParams attribute, which can be used to send arbitrary data to a custom loader, allowing for greater control of image CDN features. PR Close #48907
2023-02-01 15:38:19 -08:00
NG_FOR_MISSING_DIFFER = -2200,
fix(common): warn if using ngSrcset without a configured image loader (#48804) Warn the user in the console in case the `ngSrcset` is present and no loader is configured. In this case, the default loader is used and it ignores this attribute. PR Close #48804
2023-01-23 00:06:45 +01:00
// (undocumented)
refactor(common): drop `ngIf` assert template error in production (#59705) This commit removes the `assertTemplate` error message in production. PR Close #59705
2025-01-24 17:25:32 +02:00
NG_IF_NOT_A_TEMPLATE_REF = 2020,
refactor(common): drop error messages in production (#60415) Drops more error messages in production. PR Close #60415
2025-03-17 11:18:13 +02:00
// (undocumented)
NO_PLURAL_MESSAGE_FOUND = 2308,
refactor(common): drop `ngIf` assert template error in production (#59705) This commit removes the `assertTemplate` error message in production. PR Close #59705
2025-01-24 17:25:32 +02:00
// (undocumented)
feat(common): warn if rendered size is much smaller than intrinsic (#47082) This commit adds a console warning in development mode if the ultimate rendered size of the image is much smaller than the dimensions of the requested image. In this case, the warning recommends adjusting the size of the source image or using the `rawSrcset` attribute to implement responsive sizing. PR Close #47082
2022-08-10 19:25:01 -07:00
OVERSIZED_IMAGE = 2960,
// (undocumented)
feat(common): add placeholder to NgOptimizedImage (#53783) Add a automatic placeholder implementation supporting loader-based and data URL placeholders PR Close #53783
2024-01-03 12:15:04 -08:00
OVERSIZED_PLACEHOLDER = 2965,
// (undocumented)
feat(common): add Image directive skeleton (#45627) (#47082) This commit adds Image directive skeleton as well as a set of basic tests. PR Close #47082
2022-04-15 16:58:40 -07:00
PARENT_NG_SWITCH_NOT_FOUND = 2000,
// (undocumented)
refactor(common): allow string urls in NgOptimizedImage input (#54901) With this commit it is now possible to pass an url as placeholder for the image directive. PR Close #54901
2024-04-01 13:08:51 +02:00
PLACEHOLDER_DIMENSION_LIMIT_EXCEEDED = 2967,
// (undocumented)
feat(common): verify that priority images have preconnect links (#47082) This commit updates the `NgOptimizedImage` directive to add a logic to detect whether an image, marked with the "priority" attribute has a corresponding `<link rel="preconnect">` tag in the `document.head` for better performance. PR Close #47082
2022-05-13 13:30:45 -07:00
PRIORITY_IMG_MISSING_PRECONNECT_TAG = 2956,
// (undocumented)
feat(common): support custom srcset attributes in NgOptimizedImage (#47082) This commit adds a `rawSrcset` attribute as a replacement for the `srcset` attribute. The `srcset` attribute cannot be set statically on the image directive because it would cause images to start downloading before the "loading" attribute could be set to "lazy". Changing the name to `rawSrcset` allows the directive to control the timing of image loading. It also makes it possible to support custom loaders for `srcset` file names. Rather than having to repeat the image origin for each image, the existing `rawSrc` value and image loader can be composed to generate each full URL string. The developer must only provide the necessary widths for the `srcset`. For example, the developer might write: ```markup <img rawSrc="hermes.jpg" rawSrcset="100w, 200w" ... /> ``` with a loader like: ```js const loader = (config) => `path/${config.src}?w=${config.width}`; ``` and the img tag will ultimately be set up as something like: ```markup <img src="path/hermes.jpg?w=100" srcset="path/hermes.jpg?w=100 100w, path/hermes.jpg?w=200 200w" .../> ``` PR Close #47082
2022-05-11 16:38:31 -07:00
REQUIRED_INPUT_MISSING = 2954,
refactor(common): throw an error if `width` or `height` inputs are missing or invalid (#47082) This commit updates the `NgOptimizeImage` directive to add asserts to make sure the `width` and `height` inputs are set and have correct values (numbers only). PR Close #47082
2022-05-03 18:53:45 -07:00
// (undocumented)
fix(router): handle scrollRestoration error in restricted environments (#62186) In this commit, setting `window.history.scrollRestoration` is wrapped in a try-catch block to prevent `SecurityError` exceptions in restricted contexts such as: - sandboxed iframes - partially navigated or inactive windows - test runners, extensions, or content previews If an error occurs, a runtime warning with error code [2400] is logged to the console. This avoids breaking app initialization and improves cross-browser safety. Unfortunately, it's not possible to perform any end-to-end testing of this fix. PR Close #62186
2025-06-22 01:03:13 +03:00
SCROLL_RESTORATION_UNSUPPORTED = 2400,
// (undocumented)
feat(common): throw error for suspicious date patterns (#59798) Adjusts the date pipe and formatDate function to detect suspicious usages of the week-numbering year formatter without including the week number, as this is often confused for the calendar year and likely to result in incorrect results near New Years, meaning that those issues aren't typically caught during development. This commit starts throwing a development-only error to reveal this issue right away. BREAKING CHANGE: Using the `Y` formatter (week-numbering year) without also including `w` (week number) is now detected as suspicious date pattern, as `y` is typically intended. PR Close #59798
2025-01-29 18:33:23 -05:00
SUSPICIOUS_DATE_FORMAT = 2300,
// (undocumented)
feat(common): add <link> preload tag on server for priority img (#47343) This commit adds a logic that generates preload tags for priority images, when rendering happens on the server (e.g. Angular Universal). PR Close #47343
2022-09-04 16:52:41 -07:00
TOO_MANY_PRELOADED_IMAGES = 2961,
// (undocumented)
refactor(common): Log a warning when the priority attribute of `NgOptimizedImage` is used too often. (#56669) When the DOM content is loaded, Angular will log a warning message if the `priority` attribute is applied to often on `NgOptimizedImage` directive instances. PR Close #56669
2024-06-26 00:14:43 +02:00
TOO_MANY_PRIORITY_ATTRIBUTES = 2966,
// (undocumented)
feat(common): provide an ability to exclude origins from preconnect checks in NgOptimizedImage (#47082) This commit adds an extra logic to add an ability to exclude origins from preconnect checks in NgOptimizedImage by configuring the `PRECONNECT_CHECK_BLOCKLIST` multi-provider. PR Close #47082
2022-06-06 17:19:47 -07:00
UNEXPECTED_DEV_MODE_CHECK_IN_PROD_MODE = 2958,
// (undocumented)
feat(common): support custom srcset attributes in NgOptimizedImage (#47082) This commit adds a `rawSrcset` attribute as a replacement for the `srcset` attribute. The `srcset` attribute cannot be set statically on the image directive because it would cause images to start downloading before the "loading" attribute could be set to "lazy". Changing the name to `rawSrcset` allows the directive to control the timing of image loading. It also makes it possible to support custom loaders for `srcset` file names. Rather than having to repeat the image origin for each image, the existing `rawSrc` value and image loader can be composed to generate each full URL string. The developer must only provide the necessary widths for the `srcset`. For example, the developer might write: ```markup <img rawSrc="hermes.jpg" rawSrcset="100w, 200w" ... /> ``` with a loader like: ```js const loader = (config) => `path/${config.src}?w=${config.width}`; ``` and the img tag will ultimately be set up as something like: ```markup <img src="path/hermes.jpg?w=100" srcset="path/hermes.jpg?w=100 100w, path/hermes.jpg?w=200 200w" .../> ``` PR Close #47082
2022-05-11 16:38:31 -07:00
UNEXPECTED_INPUT_CHANGE = 2953,
refactor(common): throw an error if `NgOptimizeImage` inputs change (#47082) This commit updates the `NgOptimizeImage` directive to add asserts to make sure no inputs are changed after directive initialization. PR Close #47082
2022-05-03 18:06:20 -07:00
// (undocumented)
feat(common): support custom srcset attributes in NgOptimizedImage (#47082) This commit adds a `rawSrcset` attribute as a replacement for the `srcset` attribute. The `srcset` attribute cannot be set statically on the image directive because it would cause images to start downloading before the "loading" attribute could be set to "lazy". Changing the name to `rawSrcset` allows the directive to control the timing of image loading. It also makes it possible to support custom loaders for `srcset` file names. Rather than having to repeat the image origin for each image, the existing `rawSrc` value and image loader can be composed to generate each full URL string. The developer must only provide the necessary widths for the `srcset`. For example, the developer might write: ```markup <img rawSrc="hermes.jpg" rawSrcset="100w, 200w" ... /> ``` with a loader like: ```js const loader = (config) => `path/${config.src}?w=${config.width}`; ``` and the img tag will ultimately be set up as something like: ```markup <img src="path/hermes.jpg?w=100" srcset="path/hermes.jpg?w=100 100w, path/hermes.jpg?w=200 200w" .../> ``` PR Close #47082
2022-05-11 16:38:31 -07:00
UNEXPECTED_SRC_ATTR = 2950,
// (undocumented)
refactor(common): drop error messages in production (#60242) Drops more error messages in production. PR Close #60242
2025-03-06 12:29:28 +02:00
UNEXPECTED_SRCSET_ATTR = 2951,
// (undocumented)
UNEXPECTED_TRANSLATION_TYPE = 2302,
// (undocumented)
UNKNOWN_DATE_TYPE_VALUE = 2301,
// (undocumented)
build: add a noDuplicateEnumValue rule (#63483) It caught several legitimate issues. In the cases I wasn't sure, I just disabled the rule. fixes #45843 PR Close #63483
2025-08-29 18:03:43 +02:00
UNKNOWN_ZONE_WIDTH = 2310,
refactor(common): drop value not a number message in production (#60699) Drops value not a number message in production. PR Close #60699
2025-04-02 18:55:41 +03:00
// (undocumented)
VALUE_NOT_A_NUMBER = 2309
ci: add golden files for runtime error codes (#44677) Runtime error codes in the Core, Common and Forms packages were not included into the `public-api` group reviews. This commit creates the necessary golden files to keep track of further changes in the runtime codes. This is a followup from https://github.com/angular/angular/pull/44398#issuecomment-1006910976. PR Close #44677
2022-01-10 14:09:41 -08:00
}
// (No @packageDocumentation comment for this package)
```
Reference in New Issue Copy Permalink