How mimshwright/fease works
Main Architecture Components
a) Core Function Types (Top Level)
• Factory Functions
• Combinators
• Decorators
• Presets
b) Support Layer (Bottom Level)
• Utility Functions
• Types
• Testing Infrastructure
Component Relationships
• Rounded rectangles for utility/support modules
• Hexagons for entry points (index.ts)
b) Flow and Dependencies:
• How factory functions feed into combinators and decorators
• How presets utilize the other components
• Demonstrate the utility layer supporting all upper layers
Detailed Structure
Create sections showing:
a) Factory Functions (Group in one section):
• Bounce
• Circular
• Constant
• Discrete
• Elastic
• Exponential
• Overshoot
• Random
• Threshold
• Wave
b) Combinators (Group in one section):
• Add
• Difference
• MinMax
• Split
• Transition
c) Decorators (Group in one section):
• Ease
• Effects
• Limit
• Reflect
• Repeat
• Scale
• Shift
• Stepped
• Wavify
Integration Points
How components interact:
• How presets combine multiple components
• Demo application's consumption of the library
Additional Elements
Include:
• Version/build information
• External dependencies
• Demo application architecture
Remember to include notes about:
• Type safety (TypeScript implementation)
• Testing coverage
• Build/deployment pipeline
• Demo application structure
This will create a comprehensive visualization of the library's architecture while maintaining clarity about its purpose as an animation easing function library.