react-native-reanimated 3.6.0 → 3.6.2

package/lib/typescript/reanimated2/helperTypes.d.ts

@@ -27,16 +27,58 @@ type RestProps<Props extends object> = {
     [K in keyof Omit<Props, keyof PickStyleProps<Props> | 'style'>]: Props[K] | SharedValue<Props[K]>;
 };
 type LayoutProps = {
+    /**
+     * Lets you animate the layout changes when components are added to or removed from the view hierarchy.
+     *
+     * You can use the predefined layout transitions (eg. `LinearTransition`, `FadingTransition`) or create your own ones.
+     *
+     * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/layout-transitions
+     */
     layout?: BaseAnimationBuilder | LayoutAnimationFunction | typeof BaseAnimationBuilder;
+    /**
+     * Lets you animate an element when it's added to or removed from the view hierarchy.
+     *
+     * You can use the predefined entering animations (eg. `FadeIn`, `SlideInLeft`) or create your own ones.
+     *
+     * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations
+     */
     entering?: EntryOrExitLayoutType;
+    /**
+     * Lets you animate an element when it's added to or removed from the view hierarchy.
+     *
+     * You can use the predefined entering animations (eg. `FadeOut`, `SlideOutRight`) or create your own ones.
+     *
+     * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations
+     */
     exiting?: EntryOrExitLayoutType;
 };
 type SharedTransitionProps = {
+    /**
+     * Lets you animate components between two navigation screens.
+     *
+     * Assign the same `sharedTransitionTag` to [animated components](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component) on two different navigation screens to create a shared transition.
+     *
+     * @see https://docs.swmansion.com/react-native-reanimated/docs/shared-element-transitions/overview
+     * @experimental
+     */
     sharedTransitionTag?: string;
+    /**
+     * Lets you create a custom shared transition animation.
+     *
+     * Used alongside `SharedTransition.custom()` method.
+     *
+     * @see https://docs.swmansion.com/react-native-reanimated/docs/shared-element-transitions/overview
+     * @experimental
+     */
     sharedTransitionStyle?: SharedTransition;
 };
 type AnimatedPropsProp<Props extends object> = RestProps<Props> & AnimatedStyleProps<Props> & LayoutProps & SharedTransitionProps;
 export type AnimatedProps<Props extends object> = RestProps<Props> & AnimatedStyleProps<Props> & LayoutProps & SharedTransitionProps & {
+    /**
+     * Lets you animate component props.
+     *
+     * @see https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedProps
+     */
     animatedProps?: Partial<AnimatedPropsProp<Props>>;
 };
 export type AnimatedPropsAdapterFunction = (props: Record<string, unknown>) => void;
@@ -52,11 +94,11 @@ export type AdaptTransforms<T> = {
     [P in keyof T]: Adaptable<T[P]>;
 };
 /**
- * @deprecated Please use `TransformArrayItem` type instead.
+ * @deprecated Please use {@link TransformArrayItem} type instead.
  */
 export type TransformStyleTypes = TransformArrayItem;
 /**
- * @deprecated Please use `AnimatedStyle` type instead.
+ * @deprecated Please use {@link AnimatedStyle} type instead.
  */
 export type AnimateStyle<Style = DefaultStyle> = AnimatedStyle<Style>;
 /**
@@ -68,7 +110,7 @@ export type StylesOrDefault<T> = 'style' extends keyof T ? MaybeSharedValueRecur
  */
 export type AnimatedStyleProp<T> = AnimatedStyle<T> | RegisteredStyle<AnimatedStyle<T>>;
 /**
- * @deprecated Please use `AnimatedProps` type instead.
+ * @deprecated Please use {@link AnimatedProps} type instead.
  */
 export type AnimateProps<Props extends object> = AnimatedProps<Props>;
 export {};

package/lib/typescript/reanimated2/hook/useAnimatedKeyboard.d.ts

@@ -1,2 +1,9 @@
 import type { AnimatedKeyboardInfo, AnimatedKeyboardOptions } from '../commonTypes';
+/**
+ * Lets you synchronously get the position and state of the keyboard.
+ *
+ * @param options - An additional keyboard configuration options.
+ * @returns An object with the current keyboard `height` and `state` as [shared values](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#shared-value).
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/device/useAnimatedKeyboard
+ */
 export declare function useAnimatedKeyboard(options?: AnimatedKeyboardOptions): AnimatedKeyboardInfo;

package/lib/typescript/reanimated2/hook/useAnimatedProps.d.ts

@@ -1,2 +1,11 @@
 import type { useAnimatedPropsType } from '../helperTypes';
+/**
+ * Lets you create an animated props object which can be animated using shared values.
+ *
+ * @param updater - A function returning an object with properties you want to animate.
+ * @param dependencies - An optional array of dependencies. Only relevant when using Reanimated without the Babel plugin on the Web.
+ * @param adapters - An optional function or array of functions allowing to adopt prop naming between JS and the native side.
+ * @returns An animated props object which has to be passed to `animatedProps` property of an Animated component that you want to animate.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedProps
+ */
 export declare let useAnimatedProps: useAnimatedPropsType;

package/lib/typescript/reanimated2/hook/useAnimatedReaction.d.ts

@@ -1,8 +1,10 @@
 import type { DependencyList } from './commonTypes';
 /**
- * @param prepare - worklet used for data preparation for the second parameter
- * @param react - worklet which takes data prepared by the one in the first parameter and performs certain actions
- * the first worklet defines the inputs, in other words on which shared values change will it be called.
- * the second one can modify any shared values but those which are mentioned in the first worklet. Beware of that, because this may result in endless loop and high cpu usage.
+ * Lets you to respond to changes in a [shared value](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#shared-value). It's especially useful when comparing values previously stored in the shared value with the current one.
+ *
+ * @param prepare - A function that should return a value to which you'd like to react.
+ * @param react - A function that reacts to changes in the value returned by the `prepare` function.
+ * @param dependencies - an optional array of dependencies. Only relevant when using Reanimated without the Babel plugin on the Web.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/advanced/useAnimatedReaction
  */
 export declare function useAnimatedReaction<PreparedResult>(prepare: () => PreparedResult, react: (prepared: PreparedResult, previous: PreparedResult | null) => void, dependencies?: DependencyList): void;

package/lib/typescript/reanimated2/hook/useAnimatedRef.d.ts

@@ -1,3 +1,9 @@
 import type { Component } from 'react';
 import type { AnimatedRef } from './commonTypes';
+/**
+ * Lets you get a reference of a view that you can use inside a worklet.
+ *
+ * @returns An object with a `.current` property which contains an instance of a component.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedRef
+ */
 export declare function useAnimatedRef<TComponent extends Component>(): AnimatedRef<TComponent>;

package/lib/typescript/reanimated2/hook/useAnimatedScrollHandler.d.ts

@@ -10,4 +10,14 @@ export interface ScrollHandlers<Context extends Record<string, unknown>> {
 }
 export type ScrollHandlerProcessed<Context extends Record<string, unknown> = Record<string, unknown>> = EventHandlerProcessed<RNNativeScrollEvent, Context>;
 export type ScrollHandlerInternal = EventHandlerInternal<RNNativeScrollEvent>;
+/**
+ * Lets you run callbacks on ScrollView events. Supports `onScroll`, `onBeginDrag`, `onEndDrag`, `onMomentumBegin`, and `onMomentumEnd` events.
+ *
+ * These callbacks are automatically workletized and ran on the UI thread.
+ *
+ * @param handlers - An object containing event handlers.
+ * @param dependencies - An optional array of dependencies. Only relevant when using Reanimated without the Babel plugin on the Web.
+ * @returns An object you need to pass to `onScroll` prop on the `Animated.ScrollView` component.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/scroll/useAnimatedScrollHandler
+ */
 export declare function useAnimatedScrollHandler<Context extends Record<string, unknown>>(handlers: ScrollHandler<Context> | ScrollHandlers<Context>, dependencies?: DependencyList): ScrollHandlerProcessed<Context>;

package/lib/typescript/reanimated2/hook/useAnimatedSensor.d.ts

@@ -1,4 +1,12 @@
 import type { SensorConfig, AnimatedSensor, Value3D, ValueRotation } from '../commonTypes';
 import { SensorType } from '../commonTypes';
+/**
+ * Lets you create animations based on data from the device's sensors.
+ *
+ * @param sensorType - Type of the sensor to use. Configured with {@link SensorType} enum.
+ * @param config - The sensor configuration - {@link SensorConfig}.
+ * @returns An object containing the sensor measurements [shared value](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#shared-value) and a function to unregister the sensor
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/device/useAnimatedSensor
+ */
 export declare function useAnimatedSensor(sensorType: SensorType.ROTATION, userConfig?: Partial<SensorConfig>): AnimatedSensor<ValueRotation>;
 export declare function useAnimatedSensor(sensorType: Exclude<SensorType, SensorType.ROTATION>, userConfig?: Partial<SensorConfig>): AnimatedSensor<Value3D>;

package/lib/typescript/reanimated2/hook/useAnimatedStyle.d.ts

@@ -1,2 +1,10 @@
 import type { DefaultStyle, DependencyList } from './commonTypes';
+/**
+ * Lets you create a styles object, similar to StyleSheet styles, which can be animated using shared values.
+ *
+ * @param updater - A function returning an object with style properties you want to animate.
+ * @param dependencies - An optional array of dependencies. Only relevant when using Reanimated without the Babel plugin on the Web.
+ * @returns An animated style object which has to be passed to the `style` property of an Animated component you want to animate.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedStyle
+ */
 export declare function useAnimatedStyle<Style extends DefaultStyle>(updater: () => Style, dependencies?: DependencyList | null): Style;

package/lib/typescript/reanimated2/hook/useDerivedValue.d.ts

@@ -1,4 +1,12 @@
 import type { SharedValue } from '../commonTypes';
 import type { DependencyList } from './commonTypes';
 export type DerivedValue<Value> = Readonly<SharedValue<Value>>;
-export declare function useDerivedValue<Value>(processor: () => Value, dependencies?: DependencyList): DerivedValue<Value>;
+/**
+ * Lets you create new shared values based on existing ones while keeping them reactive.
+ *
+ * @param updater - A function called whenever at least one of the shared values or state used in the function body changes.
+ * @param dependencies - An optional array of dependencies. Only relevant when using Reanimated without the Babel plugin on the Web.
+ * @returns A new readonly shared value based on a value returned from the updater function
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/core/useDerivedValue
+ */
+export declare function useDerivedValue<Value>(updater: () => Value, dependencies?: DependencyList): DerivedValue<Value>;

package/lib/typescript/reanimated2/hook/useEvent.d.ts

@@ -5,12 +5,15 @@ import type { ReanimatedEvent } from './commonTypes';
  * Worklet to provide as an argument to `useEvent` hook.
  */
 export type EventHandler<Event extends object, Context extends Record<string, unknown> = never> = (event: ReanimatedEvent<Event>, context?: Context) => void;
-/**
- * Return type of `useEvent` hook.
- */
 export type EventHandlerProcessed<Event extends object, Context extends Record<string, unknown> = never> = (event: Event, context?: Context) => void;
+export type EventHandlerInternal<Event extends object> = MutableRefObject<WorkletEventHandler<Event>>;
 /**
- * Real return type of `useEvent` hook - only meant to be used internally.
+ * Lets you run a function whenever a specified native event occurs.
+ *
+ * @param handler - A function that receives an event object with event data - {@link EventHandler}.
+ * @param eventNames - An array of event names the `handler` callback will react to.
+ * @param rebuild - Whether the event handler should be rebuilt. Defaults to `false`.
+ * @returns A function that will be called when the event occurs - {@link EventHandlerProcessed}.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/advanced/useEvent
  */
-export type EventHandlerInternal<Event extends object> = MutableRefObject<WorkletEventHandler<Event>>;
 export declare function useEvent<Event extends object, Context extends Record<string, unknown> = never>(handler: EventHandler<Event, Context>, eventNames?: string[], rebuild?: boolean): EventHandlerProcessed<Event, Context>;

package/lib/typescript/reanimated2/hook/useFrameCallback.d.ts

@@ -1,7 +1,21 @@
 import type { FrameInfo } from '../frameCallback/FrameCallbackRegistryUI';
+/**
+ * @param setActive - A function that lets you start the frame callback or stop it from running.
+ * @param isActive - A boolean indicating whether a callback is running.
+ * @param callbackId - A number indicating a unique identifier of the frame callback.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/advanced/useFrameCallback#returns
+ */
 export type FrameCallback = {
     setActive: (isActive: boolean) => void;
     isActive: boolean;
     callbackId: number;
 };
+/**
+ * Lets you run a function on every frame update.
+ *
+ * @param callback - A function executed on every frame update.
+ * @param autostart - Whether the callback should start automatically. Defaults to `true`.
+ * @returns A frame callback object - {@link FrameCallback}.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/advanced/useFrameCallback
+ */
 export declare function useFrameCallback(callback: (frameInfo: FrameInfo) => void, autostart?: boolean): FrameCallback;

package/lib/typescript/reanimated2/hook/useHandler.d.ts

@@ -8,5 +8,13 @@ export interface UseHandlerContext<Context extends Record<string, unknown>> {
     doDependenciesDiffer: boolean;
     useWeb: boolean;
 }
+/**
+ * Lets you find out whether the event handler dependencies have changed.
+ *
+ * @param handlers - An object of event handlers.
+ * @param dependencies - An optional array of dependencies.
+ * @returns An object containing a boolean indicating whether the dependencies have changed, and a boolean indicating whether the code is running on the web.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/advanced/useHandler
+ */
 export declare function useHandler<Event extends object, Context extends Record<string, unknown>>(handlers: GeneralHandlers<Event, Context>, dependencies?: DependencyList): UseHandlerContext<Context>;
 export {};

package/lib/typescript/reanimated2/hook/useReducedMotion.d.ts

@@ -1 +1,9 @@
+/**
+ * Lets you query the reduced motion system setting.
+ *
+ * Changing the reduced motion system setting doesn't cause your components to rerender.
+ *
+ * @returns A boolean indicating whether the reduced motion setting was enabled when the app started.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/device/useReducedMotion
+ */
 export declare function useReducedMotion(): boolean;

package/lib/typescript/reanimated2/hook/useScrollViewOffset.d.ts

@@ -1,4 +1,11 @@
 import type { SharedValue } from '../commonTypes';
 import type { AnimatedScrollView } from '../component/ScrollView';
 import type { AnimatedRef } from './commonTypes';
+/**
+ * Lets you synchronously get the current offset of a `ScrollView`.
+ *
+ * @param animatedRef - An [animated ref](https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedRef) attached to an Animated.ScrollView component.
+ * @returns A shared value which holds the current offset of the `ScrollView`.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/scroll/useScrollViewOffset
+ */
 export declare function useScrollViewOffset(animatedRef: AnimatedRef<AnimatedScrollView>, initialRef?: SharedValue<number>): SharedValue<number>;

package/lib/typescript/reanimated2/hook/useSharedValue.d.ts

@@ -1,2 +1,9 @@
 import type { SharedValue } from '../commonTypes';
-export declare function useSharedValue<Value>(init: Value, oneWayReadsOnly?: boolean): SharedValue<Value>;
+/**
+ * Lets you define [shared values](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#shared-value) in your components.
+ *
+ * @param initialValue - The value you want to be initially stored to a `.value` property.
+ * @returns A shared value with a single `.value` property initially set to the `initialValue` - {@link SharedValue}.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/core/useSharedValue
+ */
+export declare function useSharedValue<Value>(initialValue: Value, oneWayReadsOnly?: boolean): SharedValue<Value>;

package/lib/typescript/reanimated2/hook/useWorkletCallback.d.ts

@@ -1,2 +1,5 @@
 import type { DependencyList } from './commonTypes';
+/**
+ * @deprecated don't use
+ */
 export declare function useWorkletCallback<Args extends unknown[], ReturnValue>(worklet: (...args: Args) => ReturnValue, deps?: DependencyList): (...args: Args) => ReturnValue;

package/lib/typescript/reanimated2/index.d.ts

@@ -10,7 +10,7 @@ export { Extrapolation, interpolate, clamp } from './interpolation';
 export type { InterpolationOptions, InterpolateConfig, InterpolateRGB, InterpolateHSV, } from './interpolateColor';
 export { 
 /**
- * @deprecated Please use `Extrapolation` instead.
+ * @deprecated Please use {@link Extrapolation} instead.
  */
 Extrapolate, ColorSpace, interpolateColor, useInterpolateConfig, } from './interpolateColor';
 export type { EasingFunction, EasingFn, EasingFunctionFactory, EasingFactoryFn, } from './Easing';

package/lib/typescript/reanimated2/interpolateColor.d.ts

@@ -4,6 +4,12 @@ import type { SharedValue } from './commonTypes';
  * @deprecated Please use Extrapolation instead
  */
 export declare const Extrapolate: typeof Extrapolation;
+/**
+ * Options for color interpolation.
+ *
+ * @param gamma - Gamma value used in gamma correction. Defaults to `2.2`.
+ * @param useCorrectedHSVInterpolation - Whether to reduce the number of colors the interpolation has to go through. Defaults to `true`.
+ */
 export type InterpolationOptions = {
     gamma?: number;
     useCorrectedHSVInterpolation?: boolean;
@@ -20,6 +26,17 @@ export interface InterpolateHSV {
     v: number[];
     a: number[];
 }
+/**
+ * Lets you map a value from a range of numbers to a range of colors using linear interpolation.
+ *
+ * @param value - A number from the `input` range that is going to be mapped to the color in the `output` range.
+ * @param inputRange - An array of numbers specifying the input range of the interpolation.
+ * @param outputRange - An array of output colors values (eg. "red", "#00FFCC", "rgba(255, 0, 0, 0.5)").
+ * @param colorSpace - The color space to use for interpolation. Defaults to 'RGB'.
+ * @param options - Additional options for interpolation - {@link InterpolationOptions}.
+ * @returns The color after interpolation from within the output range in rgba(r, g, b, a) format.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/utilities/interpolateColor
+ */
 export declare function interpolateColor(value: number, inputRange: readonly number[], outputRange: readonly string[], colorSpace?: 'RGB' | 'HSV', options?: InterpolationOptions): string;
 export declare function interpolateColor(value: number, inputRange: readonly number[], outputRange: readonly number[], colorSpace?: 'RGB' | 'HSV', options?: InterpolationOptions): number;
 export declare enum ColorSpace {

package/lib/typescript/reanimated2/interpolation.d.ts

@@ -1,21 +1,49 @@
+/**
+ * Extrapolation type.
+ *
+ * @param IDENTITY - Returns the provided value as is.
+ * @param CLAMP - Clamps the value to the edge of the output range.
+ * @param EXTEND - Predicts the values beyond the output range.
+ */
 export declare enum Extrapolation {
     IDENTITY = "identity",
     CLAMP = "clamp",
     EXTEND = "extend"
 }
+/**
+ * Represents the possible values for extrapolation as a string.
+ */
 type ExtrapolationAsString = 'identity' | 'clamp' | 'extend';
+/**
+ * Allows to specify extrapolation for left and right edge of the interpolation.
+ */
 export interface ExtrapolationConfig {
     extrapolateLeft?: Extrapolation | string;
     extrapolateRight?: Extrapolation | string;
 }
+/**
+ * Configuration options for extrapolation.
+ */
 export type ExtrapolationType = ExtrapolationConfig | Extrapolation | ExtrapolationAsString | undefined;
-export declare function interpolate(x: number, input: readonly number[], output: readonly number[], type?: ExtrapolationType): number;
 /**
- * `clamp` lets you limit a value within a specified range.
+ * Lets you map a value from one range to another using linear interpolation.
+ *
+ * @param value - A number from the `input` range that is going to be mapped to the `output` range.
+ * @param inputRange - An array of numbers specifying the input range of the interpolation.
+ * @param outputRange - An array of numbers specifying the output range of the interpolation.
+ * @param extrapolate - determines what happens when the `value` goes beyond the `input` range. Defaults to `Extrapolation.EXTEND` - {@link ExtrapolationType}.
+ * @returns A mapped value within the output range.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/utilities/interpolate
+ */
+export declare function interpolate(x: number, inputRange: readonly number[], outputRange: readonly number[], type?: ExtrapolationType): number;
+/**
+ * Lets you limit a value within a specified range.
  *
  * @param value - A number that will be returned as long as the provided value is in range between `min` and `max`.
  * @param min - A number which will be returned when provided `value` is lower than `min`.
  * @param max - A number which will be returned when provided `value` is higher than `max`.
+ * @returns A number between min and max bounds.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/utilities/clamp/
  */
 export declare function clamp(value: number, min: number, max: number): number;
 export {};

package/lib/typescript/reanimated2/layoutReanimation/animationBuilder/BaseAnimationBuilder.d.ts

@@ -8,16 +8,39 @@ export declare class BaseAnimationBuilder {
     callbackV?: (finished: boolean) => void;
     static createInstance: <T extends typeof BaseAnimationBuilder>(this: T) => InstanceType<T>;
     build: () => EntryExitAnimationFunction | LayoutAnimationFunction;
+    /**
+     * Lets you adjust the animation duration. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param durationMs - Length of the animation (in milliseconds).
+     */
     static duration<T extends typeof BaseAnimationBuilder>(this: T, durationMs: number): InstanceType<T>;
     duration(durationMs: number): this;
+    /**
+     * Lets you adjust the delay before the animation starts (in milliseconds). Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param delayMs - Delay before the animation starts (in milliseconds).
+     */
     static delay<T extends typeof BaseAnimationBuilder>(this: T, delayMs: number): InstanceType<T>;
     delay(delayMs: number): this;
+    /**
+     * The callback that will fire after the animation ends. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param callback - Callback that will fire after the animation ends.
+     */
     static withCallback<T extends typeof BaseAnimationBuilder>(this: T, callback: (finished: boolean) => void): InstanceType<T>;
-    withCallback(callback: (finsihed: boolean) => void): this;
-    static reduceMotion<T extends typeof BaseAnimationBuilder>(this: T, reduceMotionV: ReduceMotion): InstanceType<T>;
+    withCallback(callback: (finished: boolean) => void): this;
+    /**
+     * Lets you adjust the behavior when the device's reduced motion accessibility setting is turned on.  Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param reduceMotion - Determines how the animation responds to the device's reduced motion accessibility setting. Default to `ReduceMotion.System` - {@link ReduceMotion}.
+     */
+    static reduceMotion<T extends typeof BaseAnimationBuilder>(this: T, reduceMotion: ReduceMotion): InstanceType<T>;
     reduceMotion(reduceMotionV: ReduceMotion): this;
     static getDuration(): number;
     getDuration(): number;
+    /**
+     * @deprecated Use `.delay()` with `Math.random()` instead
+     */
     static randomDelay<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     randomDelay(): this;
     getDelay(): number;

package/lib/typescript/reanimated2/layoutReanimation/animationBuilder/ComplexAnimationBuilder.d.ts

@@ -15,26 +15,81 @@ export declare class ComplexAnimationBuilder extends BaseAnimationBuilder {
     restSpeedThresholdV?: number;
     initialValues?: StyleProps;
     static createInstance: <T extends typeof BaseAnimationBuilder>(this: T) => InstanceType<T>;
+    /**
+     * Lets you change the easing curve of the animation. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param easingFunction - An easing function which defines the animation curve.
+     */
     static easing<T extends typeof ComplexAnimationBuilder>(this: T, easingFunction: EasingFunction): InstanceType<T>;
     easing(easingFunction: EasingFunction): this;
+    /**
+     * Lets you rotate the element. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param degree - The rotation degree.
+     */
     static rotate<T extends typeof ComplexAnimationBuilder>(this: T, degree: string): InstanceType<T>;
     rotate(degree: string): this;
+    /**
+     * Enables the spring-based animation configuration. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param duration - An optional duration of the spring animation (in milliseconds).
+     */
     static springify<T extends typeof ComplexAnimationBuilder>(this: T, duration?: number): ComplexAnimationBuilder;
     springify(duration?: number): this;
+    /**
+     * Lets you adjust the spring animation damping ratio. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param dampingRatio - How damped the spring is.
+     */
     static dampingRatio<T extends typeof ComplexAnimationBuilder>(this: T, dampingRatio: number): InstanceType<T>;
-    dampingRatio(dampingRatio: number): this;
+    dampingRatio(value: number): this;
+    /**
+     * Lets you adjust the spring animation damping. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param value - Decides how quickly a spring stops moving. Higher damping means the spring will come to rest faster.
+     */
     static damping<T extends typeof ComplexAnimationBuilder>(this: T, damping: number): InstanceType<T>;
     damping(damping: number): this;
+    /**
+     * Lets you adjust the spring animation mass. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param mass - The weight of the spring. Reducing this value makes the animation faster.
+     */
     static mass<T extends typeof ComplexAnimationBuilder>(this: T, mass: number): InstanceType<T>;
     mass(mass: number): this;
+    /**
+     * Lets you adjust the stiffness of the spring animation. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param stiffness - How bouncy the spring is.
+     */
     static stiffness<T extends typeof ComplexAnimationBuilder>(this: T, stiffness: number): InstanceType<T>;
     stiffness(stiffness: number): this;
+    /**
+     * Lets you adjust overshoot clamping of the spring. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param overshootClamping - Whether a spring can bounce over the final position.
+     */
     static overshootClamping<T extends typeof ComplexAnimationBuilder>(this: T, overshootClamping: number): InstanceType<T>;
     overshootClamping(overshootClamping: number): this;
+    /**
+     * Lets you adjust the rest displacement threshold of the spring animation. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param restDisplacementThreshold - The displacement below which the spring will snap to the designated position without further oscillations.
+     */
     static restDisplacementThreshold<T extends typeof ComplexAnimationBuilder>(this: T, restDisplacementThreshold: number): InstanceType<T>;
     restDisplacementThreshold(restDisplacementThreshold: number): this;
+    /**
+     * Lets you adjust the rest speed threshold of the spring animation. Can be chained alongside other [layout animation modifiers](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#layout-animation-modifier).
+     *
+     * @param restSpeedThreshold - The speed in pixels per second from which the spring will snap to the designated position without further oscillations.
+     */
     static restSpeedThreshold<T extends typeof ComplexAnimationBuilder>(this: T, restSpeedThreshold: number): InstanceType<T>;
     restSpeedThreshold(restSpeedThreshold: number): this;
+    /**
+     * Lets you override the initial config of the animation
+     *
+     * @param values - An object containing the styles to override.
+     */
     static withInitialValues<T extends typeof ComplexAnimationBuilder>(this: T, values: StyleProps): InstanceType<T>;
     withInitialValues(values: StyleProps): this;
     getAnimationAndConfig(): LayoutAnimationAndConfig;

package/lib/typescript/reanimated2/layoutReanimation/animationBuilder/commonTypes.d.ts

@@ -74,6 +74,10 @@ export interface IExitAnimationBuilder {
 export type ProgressAnimationCallback = (viewTag: number, progress: number) => void;
 export type ProgressAnimation = (viewTag: number, values: SharedTransitionAnimationsValues, progress: number) => void;
 export type CustomProgressAnimation = (values: SharedTransitionAnimationsValues, progress: number) => StyleProps;
+/**
+ * Used to configure the `.defaultTransitionType()` shared transition modifier.
+ * @experimental
+ */
 export declare enum SharedTransitionType {
     ANIMATION = "animation",
     PROGRESS_ANIMATION = "progressAnimation"