Deliver web apps with confidence 🚀
Find a file
Pawel Kozlowski c7ff9dff2c fix(core): drop mutate function from the signals public API (#51821)
This change removes the `mutate` method from the `WritableSignal` interface and
completely drops it from the public API surface.

The initial API proposal for Angular signals included the mutate method, allowing
in-place modification of JS objects, without changing their references (identity).
This was based on the reasoning that identity change on modification is not necessary
as we can send the “modified” notification through the signals graph.
Unfortunately the signal-specific change notification is lost as soon as we read
signal value outside of a reactive context (outside of a reactive graph).
In other words - any code outside of the Angular signals library can’t know
that an object is modified.

Secondly, to make the mutate method work, we’ve defaulted the signal value equality function
to the one that considers non-primitive values as always different.
This is unfortunate for people working with immutable data structures
(this is notably the case for the popular state management libraries)
as the default equality function de-optimizes memoization in computed,
making the application less performant.

Given the above reasons we prefer to remove the mutate method in the signals library -
at least for now. There are just too many sharp edges and tradeoffs that we don’t fully
understand yet.

BREAKING CHANGE:

The  `mutate` method was removed from the `WritableSignal` interface and completely
dropped from the public API surface. As an alternative please use the update method and
make immutable changes to the object.

Example before:

```typescript
items.mutate(itemsArray => itemsArray.push(newItem));
```

Example after:

```typescript
items.update(itemsArray => [itemsArray, …newItem]);
```

PR Close #51821
2023-10-05 14:40:50 -07:00
.circleci ci: migrate snapshot publishing from CircleCI to GHA (#51957) 2023-10-05 10:53:22 -07:00
.devcontainer build: use pin for devcontainer base image (#51556) 2023-08-29 18:38:55 +00:00
.github build: update github/codeql-action action to v2.21.9 (#51992) 2023-10-05 14:07:21 -07:00
.husky build: remove unnecessary husky gitignore file (#42870) 2021-07-19 17:31:55 -07:00
.ng-dev build: remove the webworker platform. (#50059) 2023-05-04 09:06:55 +02:00
.vscode docs: minor update to modify the Bazel extension url (#51925) 2023-09-27 09:21:33 -07:00
.yarn build: update yarn (#50732) 2023-06-16 10:51:09 +02:00
aio docs: update Angular CLI help [main] (#52022) 2023-10-05 10:53:56 -07:00
devtools feat(devtools): added instances count and total time in bar chart (#50866) 2023-09-22 09:50:52 -07:00
docs docs: minor update to modify the Bazel extension url (#51925) 2023-09-27 09:21:33 -07:00
goldens fix(core): drop mutate function from the signals public API (#51821) 2023-10-05 14:40:50 -07:00
integration feat(core): enable block syntax (#51994) 2023-10-03 15:26:05 -07:00
modules build: fix IDE completion for benchmarks code (#51887) 2023-10-04 08:14:35 -07:00
packages fix(core): drop mutate function from the signals public API (#51821) 2023-10-05 14:40:50 -07:00
scripts ci: migrate snapshot publishing from CircleCI to GHA (#51957) 2023-10-05 10:53:22 -07:00
third_party build: create NodeJS ESM loader for supporting Bazel setup (#48521) 2022-12-19 19:50:40 +00:00
tools ci: migrate saucelabs bazel job to Github Actions (#51945) 2023-10-05 09:18:34 -07:00
.bazelignore build: include bazel build file in aio playground code (#51485) 2023-08-23 14:44:03 -07:00
.bazelrc build: migrate project_id option to use bes_instance_name (#51696) 2023-09-07 13:49:07 -07:00
.bazelversion build: update to bazel v5 for new runfiles API used in dev-infra (#45407) 2022-03-21 16:55:36 -07:00
.clang-format feat(tooling): Add a .clang-format for automated JavaScript formatting. 2015-04-02 08:44:34 -07:00
.editorconfig build: use https link to editorconfig.org in .editorconfig (#27664) 2018-12-18 09:30:09 -08:00
.gitattributes build: cleanup .gitattributes file and remove outdated CRLF attribute (#46513) 2022-06-28 13:38:27 -07:00
.gitignore docs: update of landing page and backup pages (#47047) 2022-12-09 16:04:34 -08:00
.gitmessage build: clean up references to old master branch (#45856) 2022-05-04 16:23:33 -07:00
.mailmap build: add a Git .mailmap with my new name (#19550) 2017-10-09 14:35:30 -07:00
.npmrc build: rely on engines to prevent using npm for dependency install (#41477) 2021-04-07 12:05:01 -07:00
.nvmrc build: migrate to node 18 (#51609) 2023-09-01 15:12:43 +00:00
.prettierrc ci: use prettier to format yml files (#42136) 2021-05-19 11:20:20 -07:00
.pullapprove.yml build: update dependency jasmine to v5 (#51820) 2023-09-19 18:40:16 +02:00
.yarnrc build: update yarn (#50732) 2023-06-16 10:51:09 +02:00
browser-providers.conf.d.ts build: share Saucelabs browsers between karma test targets using background Saucelabs daemon and custom karma launcher (#49200) 2023-05-15 09:21:46 -07:00
browser-providers.conf.js ci: enable Android 12 for tests on CI (#45926) 2022-05-09 11:26:10 -07:00
BUILD.bazel build: update yarn (#50732) 2023-06-16 10:51:09 +02:00
CHANGELOG.md release: cut the v17.0.0-next.7 release 2023-10-04 14:31:00 -07:00
CHANGELOG_ARCHIVE.md docs: fix typos 2023-06-22 12:56:49 +02:00
CODE_OF_CONDUCT.md build: update CODE_OF_CONDUCT.md to match the content of angular/.github 2023-03-13 21:07:51 +00:00
CONTRIBUTING.md docs: Fix misspelling in note of git commit --all (#51735) 2023-09-12 12:25:42 -07:00
gulpfile.js build: remove the unused source-map-test (#46518) 2022-06-27 15:42:43 -07:00
karma-js.conf.js build: share Saucelabs browsers between karma test targets using background Saucelabs daemon and custom karma launcher (#49200) 2023-05-15 09:21:46 -07:00
LICENSE build: bump license year (#49984) 2023-04-25 09:29:16 -07:00
package.json release: cut the v17.0.0-next.7 release 2023-10-04 14:31:00 -07:00
packages.bzl feat(animations): Add the possibility of lazy loading animations code. (#50738) 2023-09-29 10:49:39 -07:00
README.md docs: updated the i tag with the em tag (#50923) 2023-07-10 07:15:49 -07:00
renovate.json ci: update renovate.json (#49909) 2023-04-18 20:54:28 +00:00
SECURITY.md build: update SECURITY.md to match the content of angular/.github 2023-01-06 08:51:29 +00:00
tsconfig-tslint.json refactor(devtools): run ng-dev format on angular devtools files 2022-01-26 16:35:30 -05:00
tslint.json build: update lint path for @angular/build-tooling rules (#49266) 2023-02-28 11:56:28 -08:00
WORKSPACE build: update dependency jasmine to v5 (#51820) 2023-09-19 18:40:16 +02:00
yarn.bzl build: update yarn (#50732) 2023-06-16 10:51:09 +02:00
yarn.lock build: lock file maintenance (#51834) 2023-10-04 11:31:27 -07:00
yarn.lock.readme.md build: clean up references to old master branch (#45856) 2022-05-04 16:23:33 -07:00

Angular - The modern web developer's platform

angular-logo
Angular is a development platform for building mobile and desktop web applications
using TypeScript/JavaScript and other languages.

www.angular.io

Contributing Guidelines · Submit an Issue · Blog

CI status   Angular on npm   Discord conversation

InsightsSnapshot


Documentation

Get started with Angular, learn the fundamentals and explore advanced topics on our documentation website.

Advanced

Development Setup

Prerequisites

Setting Up a Project

Install the Angular CLI globally:

npm install -g @angular/cli

Create workspace:

ng new [PROJECT NAME]

Run the application:

cd [PROJECT NAME]
ng serve

Angular is cross-platform, fast, scalable, has incredible tooling, and is loved by millions.

Quickstart

Get started in 5 minutes.

Ecosystem

angular ecosystem logos

Changelog

Learn about the latest improvements.

Upgrading

Check out our upgrade guide to find out the best way to upgrade your project.

Contributing

Contributing Guidelines

Read through our contributing guidelines to learn about our submission process, coding rules, and more.

Want to Help?

Want to report a bug, contribute some code, or improve the documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues labeled as help wanted or good first issue.

Code of Conduct

Help us keep Angular open and inclusive. Please read and follow our Code of Conduct.

Community

Join the conversation and help the community.

Love Angular badge

Love Angular? Give our repo a star ⬆️.