The Default Companion
Val.companion<V>().build() returns the default companion: seal, and
patch for a Val that holds an object payload.
The steps between Val.companion and .build() replace seal or add functions to the companion.
Write .implSeal first, then .implCreate. .impl, .implTrait and .implAssoc come next, in
any order. .impl is written once.
- Adding Functions to the Companion covers
.impland.implAssoc. - Custom Constructors and Invariants covers
.implSealand.implCreate. - Traits covers
.implTrait.
Patch object values
Without Valof, changing a deeply readonly shop means rebuilding every object on the path:
const changed = {
...shop,
owner: {
...shop.owner,
contact: {
...shop.owner.contact,
email: "e@example.com",
},
},
};
With patch, the same update lists only what changes:
const changed = Shop.patch(shop, {
owner: { contact: { email: "e@example.com" } },
});
A patch expresses three operations:
- Omit a key to leave it unchanged.
- Pass
{ k: undefined }to delete it. - Pass
{ k: value }to set it.
With exactOptionalPropertyTypes, { k: undefined } is accepted only for optional keys. Without
it, TypeScript also accepts it for required keys, and patch deletes them at runtime.
A patch reaches through nested plain objects, but replaces a nested Val, an array or a primitive whole:
Shop.patch(shop, { city: City.patch(shop.city, { name: "Osaka" }) });
Derive a nested Val with its own patch, so its own seal checks the change.
Like seal, patch reuses what is already inside the Val. It
copies only the path to what changed, and untouched branches keep their reference identity:
changed.city === shop.city; // true
Shop.patch(shop, {}) === shop; // true
Reference comparisons, such as React dependency arrays, can then skip work when their value did not change.