feat!: add immutability utilities to Obj module and make Group immutable by default #100
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for wollybeard-kit canceled.
|
…ble by default - Add Obj.toImmutable, isImmutable, isMutable, inferImmutabilityMode, forwardImmutability - forwardImmutability validates mut+imm combination with static error and runtime throw - Group.by now returns frozen group sets (use Group.byMut for mutable) - Group.merge and Group.map use polymorphic dispatch based on input immutability - Refactor Arr module to use forwardImmutability for consistent behavior BREAKING CHANGE: Group.by now returns immutable (frozen) group sets
3dfb837 to
0e96d8a
Compare
- toImmutable now creates a shallow copy then freezes (safer default) - toImmutableMut freezes in place (explicit opt-in for mutation) - Updated Arr and Group modules to use toImmutableMut for freshly created arrays to avoid unnecessary double-copy
Inverse of toImmutable - creates a shallow unfrozen copy of an object. Since Object.freeze is one-way in JS, this always creates a new object.
Obj module: - Rename toMutable → cloneToMut (clearer naming) - Add clone() - preserves immutability state Group module: - Add clone() - structure-aware, preserves state - Add cloneToMut() - structure-aware, always mutable - Add toImmutable() - clone + deep freeze - Add toImmutableMut() - deep freeze in place - Dogfood toImmutableMut in by(), merge(), map() Naming convention: - *Mut suffix = mutates input in place - *ToX suffix = transforms output to X state
Skip cloning if input is already frozen - assumes if top-level is frozen, entire DS is frozen (reasonable contract in practice).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Objmodule:toImmutable,isImmutable,isMutable,inferImmutabilityMode,forwardImmutabilityforwardImmutabilityvalidates invalidmut, immcombination with static error type and runtime throwGroup.bynow returns frozen (immutable) group sets by defaultGroup.byMutfor mutable group setsGroup.mergeandGroup.mapuse polymorphic dispatch based on input immutabilityBreaking Changes
Group.bynow returns immutable (frozen) group sets. UseGroup.byMutfor the previous mutable behavior.Test plan
pnpm check:types)pnpm test)mutability.test.tsCloses #96