chore: deprecate under-used animation helpers#30
Merged
Conversation
Marks five exports with @deprecated JSDoc tags — staggerEased, delay, sequence, parallel, calculateStaggerDelay. All are thin wrappers over Effect combinators that don't earn their own name in the API surface. Nothing is removed; callers get an editor warning and a migration hint in the JSDoc. Closes #26 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Deploying effex-api with
|
| Latest commit: |
12654be
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0ee94133.effex-api.pages.dev |
| Branch Preview URL: | https://chore-deprecate-animation-he.effex-api.pages.dev |
Deploying effex with
|
| Latest commit: |
12654be
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://10bed756.effex.pages.dev |
| Branch Preview URL: | https://chore-deprecate-animation-he.effex.pages.dev |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Marks five exports from
@effex/dom/Animationwith@deprecatedJSDoc tags:staggerEased(totalMs, easeFn)(index, total) => easeFn(index / (total - 1)) * totalMsdelay(ms, effect)Effect.delay(effect, ms)sequence(...effects)Effect.all([...], { concurrency: 1 })parallel(...effects)Effect.all([...], { concurrency: "unbounded" })calculateStaggerDelayNone of these earn their own name in the public API:
delay,sequence,parallelare one-line renames ofEffectcombinators,staggerEasedis a two-line composition, andcalculateStaggerDelaywas only ever consumed by its own test file. Keeping the framework a thin layer over Effect makes the surface easier to learn and reduces "which one do I use" cognitive load.Nothing is removed — callers just get an editor warning and a migration hint in the JSDoc. Removal will happen in the next major.
Test plan
pnpm exec tsc --noEmit(dom package) — cleanpnpm exec vitest run packages/dom/src/Animation— 21/21 passCloses #26
🤖 Generated with Claude Code