signals

                            
                              
                                import
                                
                                {
                                ...
                                }
                                
                                from
                                
                                "@motion-canvas/core/lib/signals"
                                ;
                                
                              
                            
                          

Value wrappers for easy dependency tracking and cache invalidation.

Classes

• CompoundSignalContext
• ComputedContext
• DependencyContext
• SignalContext

Interfaces

• Computed
• PromiseHandle
• Signal
• SignalGetter
• SignalSetter
• SignalTween

Type Aliases

CompoundSignal

                            
                              
                                type 
                                CompoundSignal
                                
                                  
                                    
                                      TSetterValue
                                    
                                    
                                      TValue
                                       extends 
                                      TSetterValue
                                    
                                    
                                      TKeys
                                       extends 
                                      keyof 
                                      TValue
                                    
                                    
                                      TOwner
                                    
                                    
                                      TContext
                                       = 
                                      CompoundSignalContext
                                      
                                        
                                          
                                            TSetterValue
                                          
                                          
                                            TValue
                                          
                                          
                                            TKeys
                                          
                                          
                                            TOwner
                                          
                                        
                                      
                                    
                                  
                                
                                 = 
                                
                                  
                                    
                                      Signal
                                      
                                        
                                          
                                            TSetterValue
                                          
                                          
                                            TValue
                                          
                                          
                                            TOwner
                                          
                                          
                                            TContext
                                          
                                        
                                      
                                    
                                    
                                      
                                        
                                          
                                            [
                                            K
                                             in 
                                            TKeys
                                            ]: 
                                            Signal
                                            
                                              
                                                
                                                  TValue
                                                  [
                                                  K
                                                  ]
                                                
                                                
                                                  TValue
                                                  [
                                                  K
                                                  ]
                                                
                                                
                                                  TOwner
                                                   extends 
                                                  void
                                                   ? 
                                                  CompoundSignal
                                                  
                                                    
                                                      
                                                        TSetterValue
                                                      
                                                      
                                                        TValue
                                                      
                                                      
                                                        TKeys
                                                      
                                                      
                                                        TOwner
                                                      
                                                      
                                                        TContext
                                                      
                                                    
                                                  
                                                   : 
                                                  TOwner
                                                
                                              
                                            
                                          
                                        
                                      
                                    
                                  
                                
                              
                              

                            
                          

Type Parameters

• TSetterValue
• TValue extends TSetterValue
• TKeys extends keyof TValue
• TOwner
• TContext = CompoundSignalContext TSetterValue TValue TKeys TOwner

---

SignalGenerator

                            
                              
                                type 
                                SignalGenerator
                                
                                  
                                    
                                      TSetterValue
                                    
                                    
                                      TValue
                                       extends 
                                      TSetterValue
                                    
                                  
                                
                                 = 
                                
                                  
                                    
                                      ThreadGenerator
                                    
                                    
                                      
                                        
                                          
                                            to
                                            : 
                                            SignalTween
                                            
                                              
                                                
                                                  TSetterValue
                                                
                                                
                                                  TValue
                                                
                                              
                                            
                                          
                                        
                                      
                                    
                                  
                                
                              
                              

                            
                          

Type Parameters

• TSetterValue
• TValue extends TSetterValue

---

SignalValue

                            
                              
                                type 
                                SignalValue
                                
                                  
                                    
                                      TValue
                                    
                                  
                                
                                 = 
                                
                                  
                                    
                                      TValue
                                    
                                    
                                      public 
                                      
                                      ()
                                    
                                  
                                
                              
                              

                            
                          

Type Parameters

• TValue

---

SimpleSignal

                            
                              
                                type 
                                SimpleSignal
                                
                                  
                                    
                                      TValue
                                    
                                    
                                      TReturn
                                       = 
                                      void
                                    
                                  
                                
                                 = 
                                Signal
                                
                                  
                                    
                                      TValue
                                    
                                    
                                      TValue
                                    
                                    
                                      TReturn
                                    
                                  
                                
                              
                              

                            
                          

Type Parameters

• TValue
• TReturn = void

Variables

DEFAULT

                            
                              
                                const 
                                DEFAULT
                                : 
                                typeof 
                                DEFAULT
                                 = 
                                ...
                              
                              

                            
                          

Functions

createComputed

                            
                              
                                public 
                                createComputed
                                
                                  
                                    
                                      TValue
                                    
                                  
                                
                                
                                  
                                    
                                      factory
                                      : 
                                      public 
                                      
                                      ()
                                    
                                    
                                      owner
                                      ?: 
                                      any
                                    
                                  
                                
                                : 
                                Computed
                                
                                  
                                    
                                      TValue
                                    
                                  
                                
                              
                              

                            
                          

Type Parameters

• TValue

Parameters

• factory : public ()
• owner ?: any

---

createComputedAsync

                            
                              
                                public 
                                createComputedAsync
                                
                                  
                                    
                                      T
                                    
                                  
                                
                                
                                  
                                    
                                      factory
                                      : 
                                      public 
                                      
                                      ()
                                    
                                  
                                
                                : 
                                Computed
                                
                                  
                                    
                                      
                                        
                                          
                                            T
                                          
                                          
                                            null
                                          
                                        
                                      
                                    
                                  
                                
                              
                              

                            
                          

                            
                              
                                public 
                                createComputedAsync
                                
                                  
                                    
                                      T
                                    
                                  
                                
                                
                                  
                                    
                                      factory
                                      : 
                                      public 
                                      
                                      ()
                                    
                                    
                                      initial
                                      : 
                                      T
                                    
                                  
                                
                                : 
                                Computed
                                
                                  
                                    
                                      T
                                    
                                  
                                
                              
                              

                            
                          

Type Parameters

• T

Parameters

• factory : public ()

---

createSignal

                            
                              
                                public 
                                createSignal
                                
                                  
                                    
                                      TValue
                                    
                                    
                                      TOwner
                                       = 
                                      void
                                    
                                  
                                
                                
                                  
                                    
                                      initial
                                      ?: 
                                      SignalValue
                                      
                                        
                                          
                                            TValue
                                          
                                        
                                      
                                    
                                    
                                      interpolation
                                      : 
                                      InterpolationFunction
                                      
                                        
                                          
                                            TValue
                                          
                                          
                                            any
                                            []
                                          
                                        
                                      
                                       = 
                                      deepLerp
                                    
                                    
                                      owner
                                      ?: 
                                      TOwner
                                    
                                  
                                
                                : 
                                SimpleSignal
                                
                                  
                                    
                                      TValue
                                    
                                    
                                      TOwner
                                    
                                  
                                
                              
                              

                            
                          

Type Parameters

• TValue
• TOwner = void

Parameters

• initial ?: SignalValue TValue
• interpolation : InterpolationFunction TValue any [] = deepLerp
• owner ?: TOwner

---

isReactive

                            
                              
                                public 
                                isReactive
                                
                                  
                                    
                                      T
                                    
                                  
                                
                                
                                  
                                    
                                      value
                                      : 
                                      SignalValue
                                      
                                        
                                          
                                            T
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                value 
                                is 
                                public 
                                
                                ()
                              
                              

                            
                          

Type Parameters

• T

Parameters

• value : SignalValue T