Deprecate interpolate method from animated nodes and add to AnimatedImplementation.

[DylanVann]

Motivation

// Current form.
myAnimation.interpolate(config)

// Consistent with other types of animated nodes and animations.
Animated.interpolate(myAnimation, config)
Animated.diffClamp(myAnimation, min, max)
Animated.add(myAnimation, myOtherAnimation)
Animated.sping(myAnimation, config)
Animated.timing(myAnimation, config)

• Less code duplication.
• More consistent.
• Will allow for using AnimatedValue within AnimatedInterpolation.

Test Plan

Have existing tests pass.

Could eventually be a breaking change:

• Who does this affect: Anyone using animation.interpolate(config).
• How to migrate: Switch to using Animated.interpolate(animation, config).
• Why make this breaking change: It is more consistent, reduces code duplication, and reduces the risk of creating a circular dependency.
• Severity (number of people affected x effort): This could affect a lot of people. It is relatively easy to fix though. It could probably be fixed using a codemod or even just some regex.

Release Notes

[GENERAL] [MINOR] [Native Animated] - Deprecate interpolate method from animated nodes and add to AnimatedImplementation.

[satya164]

Can we leave the interpolate method on the instance with a deprecation warning for now and remove it entirely in a later version so that libraries have time to migrate their code? Otherwise, this will break a ton of apps and libraries.

[DylanVann]

The motivation for doing this is to resolve a circular dependency that would be created by something I'm trying to do in the linked PR. So a deprecation warning wouldn't solve that problem.

There's probably some other way to resolve the circular dependency though. The interpolate method could maybe be added onto the classes in AnimatedImplementation.js. Then there would be no circular dependency and there would be less code duplication. Although I still think a deprecation warning and adding the Animate.interpolate method would be an improvement to the API.

I'll try that out later today.

[DylanVann]

Have to figure out how the flow types would work, but something like this:

function interpolate(config: InterpolationConfigType): AnimatedInterpolation {
  return new AnimatedInterpolation(this, config);
};

AnimatedAddition.prototype.interpolate = interpolate;
AnimatedValue.prototype.interpolate = interpolate;

[facebook-github-bot]

@DylanVann I tried to find reviewers for this pull request and wanted to ping them to take another look. However, based on the blame information for the files in this pull request I couldn't find any reviewers. This sometimes happens when the files in the pull request are new or don't exist on master anymore. Is this pull request still relevant? If yes could you please rebase? In case you know who has context on this code feel free to mention them in a comment (one person is fine). Thanks for reading and hope you will continue contributing to the project.

[grabbou]

FYI this is already how you do it in Reason with bs-react-native, cc: @wokalski

[wokalski]

indeed, this is the bs-react-native api, although it compiles to the current form.

[DylanVann]

Good to know that some other people thought it was a good idea.

[facebook-github-bot]

@DylanVann I tried to find reviewers for this pull request and wanted to ping them to take another look. However, based on the blame information for the files in this pull request I couldn't find any reviewers. This sometimes happens when the files in the pull request are new or don't exist on master anymore. Is this pull request still relevant? If yes could you please rebase? In case you know who has context on this code feel free to mention them in a comment (one person is fine). Thanks for reading and hope you will continue contributing to the project.