mirror of
https://github.com/zhigang1992/react-native-reanimated.git
synced 2026-04-30 21:32:03 +08:00
Update TypeScript definitions (#63)
This commit is contained in:
Jeromy Maligie
committed by
Michał Osadnik
Michał Osadnik
parent
438bb676b2
commit
0594edc36c
411
react-native-reanimated.d.ts
vendored
411
react-native-reanimated.d.ts
vendored
@@ -13,230 +13,235 @@ declare module 'react-native-reanimated' {
|
||||
TextStyle,
|
||||
ImageStyle,
|
||||
} from 'react-native';
|
||||
|
||||
class AnimatedNode<T> {
|
||||
constructor(
|
||||
nodeConfig: object,
|
||||
inputNodes?: ReadonlyArray<AnimatedNode<any>>
|
||||
);
|
||||
isNativelyInitialized(): boolean;
|
||||
/**
|
||||
* ' __value' is not available at runtime on AnimatedNode<T>. It is
|
||||
* necessary to have some discriminating property on a type to know that
|
||||
* an AnimatedNode<number> and AnimatedNode<string> are not compatible types.
|
||||
*/
|
||||
' __value': T;
|
||||
}
|
||||
// exporting the AnimatedNode as an interface because it is often needed at
|
||||
// type-time, but not available at runtime except on the default export
|
||||
interface IAnimatedNode<T> extends AnimatedNode<T> {}
|
||||
export { IAnimatedNode as AnimatedNode };
|
||||
|
||||
class AnimatedClock extends AnimatedNode<number> {
|
||||
constructor();
|
||||
}
|
||||
|
||||
enum Extrapolate {
|
||||
EXTEND = 'extend',
|
||||
CLAMP = 'clamp',
|
||||
IDENTITY = 'identity',
|
||||
}
|
||||
|
||||
interface InterpolationConfig {
|
||||
inputRange: ReadonlyArray<Adaptable<number>>;
|
||||
outputRange: ReadonlyArray<Adaptable<number>>;
|
||||
extrapolate?: Extrapolate;
|
||||
extrapolateLeft?: Extrapolate;
|
||||
extrapolateRight?: Extrapolate;
|
||||
}
|
||||
class AnimatedValue extends AnimatedNode<number> {
|
||||
constructor(value: number);
|
||||
|
||||
setValue(value: number): void;
|
||||
|
||||
interpolate(config: InterpolationConfig): AnimatedNode<number>;
|
||||
}
|
||||
|
||||
export type Mapping = { [key: string]: Mapping } | AnimatedValue;
|
||||
export type Adaptable<T> =
|
||||
| T
|
||||
| AnimatedNode<T>
|
||||
| ReadonlyArray<T | AnimatedNode<T>>;
|
||||
type BinaryOperator = (
|
||||
left: Adaptable<number>,
|
||||
right: Adaptable<number>
|
||||
) => AnimatedNode<number>;
|
||||
type UnaryOperator = (value: Adaptable<number>) => AnimatedNode<number>;
|
||||
type LogicalOperator = (
|
||||
value: Adaptable<number>,
|
||||
...others: Adaptable<number>[]
|
||||
) => AnimatedNode<number>;
|
||||
|
||||
export interface DecayState {
|
||||
finished: AnimatedValue;
|
||||
velocity: AnimatedValue;
|
||||
position: AnimatedValue;
|
||||
time: AnimatedValue;
|
||||
}
|
||||
export interface DecayConfig {
|
||||
deceleration: Adaptable<number>;
|
||||
}
|
||||
|
||||
export interface TimingState {
|
||||
finished: AnimatedValue;
|
||||
velocity: AnimatedValue;
|
||||
position: AnimatedValue;
|
||||
time: AnimatedValue;
|
||||
}
|
||||
type EasingFunction = (value: Adaptable<number>) => AnimatedNode<number>;
|
||||
export interface TimingConfig {
|
||||
toValue: Adaptable<number>;
|
||||
duration: Adaptable<number>;
|
||||
easing: EasingFunction;
|
||||
}
|
||||
|
||||
export interface SpringState {
|
||||
finished?: AnimatedValue;
|
||||
velocity?: AnimatedValue;
|
||||
position?: AnimatedValue;
|
||||
time?: AnimatedValue;
|
||||
}
|
||||
export interface SpringConfig {
|
||||
damping: Adaptable<number>;
|
||||
mass: Adaptable<number>;
|
||||
stiffness: Adaptable<number>;
|
||||
overshootClamping: Adaptable<number> | boolean;
|
||||
restSpeedThreshold: Adaptable<number>;
|
||||
restDisplacementThreshold: Adaptable<number>;
|
||||
toValue: Adaptable<number>;
|
||||
}
|
||||
|
||||
type AnimateStyle<S extends object> = {
|
||||
[K in keyof S]: S[K] extends ReadonlyArray<any>
|
||||
? ReadonlyArray<AnimateStyle<S[K][0]>>
|
||||
: S[K] extends object
|
||||
? AnimateStyle<S[K]>
|
||||
:
|
||||
| S[K]
|
||||
| AnimatedNode<
|
||||
// allow `number` where `string` normally is to support colors
|
||||
S[K] extends string ? S[K] | number : S[K]
|
||||
>
|
||||
};
|
||||
|
||||
type AnimateProps<
|
||||
S extends object,
|
||||
P extends {
|
||||
style?: StyleProp<S>;
|
||||
namespace Animated {
|
||||
class AnimatedNode<T> {
|
||||
constructor(
|
||||
nodeConfig: object,
|
||||
inputNodes?: ReadonlyArray<AnimatedNode<any>>,
|
||||
);
|
||||
isNativelyInitialized(): boolean;
|
||||
/**
|
||||
* ' __value' is not available at runtime on AnimatedNode<T>. It is
|
||||
* necessary to have some discriminating property on a type to know that
|
||||
* an AnimatedNode<number> and AnimatedNode<string> are not compatible types.
|
||||
*/
|
||||
' __value': T;
|
||||
}
|
||||
> = {
|
||||
[K in keyof P]: K extends 'style'
|
||||
? StyleProp<AnimateStyle<S>>
|
||||
: P[K] | AnimatedNode<P[K]>
|
||||
};
|
||||
|
||||
interface Animated {
|
||||
class AnimatedClock extends AnimatedNode<number> {
|
||||
constructor();
|
||||
}
|
||||
|
||||
export enum Extrapolate {
|
||||
EXTEND = 'extend',
|
||||
CLAMP = 'clamp',
|
||||
IDENTITY = 'identity',
|
||||
}
|
||||
|
||||
export interface InterpolationConfig {
|
||||
inputRange: ReadonlyArray<Adaptable<number>>;
|
||||
outputRange: ReadonlyArray<Adaptable<number>>;
|
||||
extrapolate?: Extrapolate;
|
||||
extrapolateLeft?: Extrapolate;
|
||||
extrapolateRight?: Extrapolate;
|
||||
}
|
||||
class AnimatedValue extends AnimatedNode<number> {
|
||||
constructor(value: number);
|
||||
|
||||
setValue(value: number): void;
|
||||
|
||||
interpolate(config: InterpolationConfig): AnimatedNode<number>;
|
||||
}
|
||||
|
||||
export type Mapping = { [key: string]: Mapping } | AnimatedValue;
|
||||
export type Adaptable<T> =
|
||||
| T
|
||||
| AnimatedNode<T>
|
||||
| ReadonlyArray<T | AnimatedNode<T>>;
|
||||
type BinaryOperator = (
|
||||
left: Adaptable<number>,
|
||||
right: Adaptable<number>,
|
||||
) => AnimatedNode<number>;
|
||||
type UnaryOperator = (value: Adaptable<number>) => AnimatedNode<number>;
|
||||
type LogicalOperator = (
|
||||
value: Adaptable<number>,
|
||||
...others: Adaptable<number>[]
|
||||
) => AnimatedNode<number>;
|
||||
|
||||
export interface DecayState {
|
||||
finished: AnimatedValue;
|
||||
velocity: AnimatedValue;
|
||||
position: AnimatedValue;
|
||||
time: AnimatedValue;
|
||||
}
|
||||
export interface DecayConfig {
|
||||
deceleration: Adaptable<number>;
|
||||
}
|
||||
|
||||
export interface TimingState {
|
||||
finished: AnimatedValue;
|
||||
velocity: AnimatedValue;
|
||||
position: AnimatedValue;
|
||||
time: AnimatedValue;
|
||||
}
|
||||
export type EasingFunction = (
|
||||
value: Adaptable<number>,
|
||||
) => AnimatedNode<number>;
|
||||
export interface TimingConfig {
|
||||
toValue: Adaptable<number>;
|
||||
duration: Adaptable<number>;
|
||||
easing: EasingFunction;
|
||||
}
|
||||
|
||||
export interface SpringState {
|
||||
finished?: AnimatedValue;
|
||||
velocity?: AnimatedValue;
|
||||
position?: AnimatedValue;
|
||||
time?: AnimatedValue;
|
||||
}
|
||||
export interface SpringConfig {
|
||||
damping: Adaptable<number>;
|
||||
mass: Adaptable<number>;
|
||||
stiffness: Adaptable<number>;
|
||||
overshootClamping: Adaptable<number> | boolean;
|
||||
restSpeedThreshold: Adaptable<number>;
|
||||
restDisplacementThreshold: Adaptable<number>;
|
||||
toValue: Adaptable<number>;
|
||||
}
|
||||
|
||||
type AnimateStyle<S extends object> = {
|
||||
[K in keyof S]: S[K] extends ReadonlyArray<any>
|
||||
? ReadonlyArray<AnimateStyle<S[K][0]>>
|
||||
: S[K] extends object
|
||||
? AnimateStyle<S[K]>
|
||||
:
|
||||
| S[K]
|
||||
| AnimatedNode<
|
||||
// allow `number` where `string` normally is to support colors
|
||||
S[K] extends string ? S[K] | number : S[K]
|
||||
>
|
||||
};
|
||||
|
||||
type AnimateProps<
|
||||
S extends object,
|
||||
P extends {
|
||||
style?: StyleProp<S>;
|
||||
}
|
||||
> = {
|
||||
[K in keyof P]: K extends 'style'
|
||||
? StyleProp<AnimateStyle<S>>
|
||||
: P[K] | AnimatedNode<P[K]>
|
||||
};
|
||||
|
||||
// components
|
||||
View: ComponentClass<AnimateProps<ViewStyle, ViewProps>>;
|
||||
Text: ComponentClass<AnimateProps<TextStyle, TextProps>>;
|
||||
Image: ComponentClass<AnimateProps<ImageStyle, ImageProps>>;
|
||||
ScrollView: ComponentClass<AnimateProps<ViewStyle, ScrollViewProps>>;
|
||||
export const View: ComponentClass<AnimateProps<ViewStyle, ViewProps>>;
|
||||
export const Text: ComponentClass<AnimateProps<TextStyle, TextProps>>;
|
||||
export const Image: ComponentClass<AnimateProps<ImageStyle, ImageProps>>;
|
||||
export const ScrollView: ComponentClass<
|
||||
AnimateProps<ViewStyle, ScrollViewProps>
|
||||
>;
|
||||
|
||||
// classes
|
||||
Clock: typeof AnimatedClock;
|
||||
Value: typeof AnimatedValue;
|
||||
Node: typeof AnimatedNode;
|
||||
export {
|
||||
AnimatedClock as Clock,
|
||||
AnimatedNode as Node,
|
||||
AnimatedValue as Value,
|
||||
};
|
||||
|
||||
// base operations
|
||||
add: BinaryOperator;
|
||||
sub: BinaryOperator;
|
||||
multiply: BinaryOperator;
|
||||
divide: BinaryOperator;
|
||||
pow: BinaryOperator;
|
||||
modulo: BinaryOperator;
|
||||
sqrt: UnaryOperator;
|
||||
sin: UnaryOperator;
|
||||
cos: UnaryOperator;
|
||||
exp: UnaryOperator;
|
||||
round: UnaryOperator;
|
||||
lessThan: BinaryOperator;
|
||||
eq: BinaryOperator;
|
||||
greaterThan: BinaryOperator;
|
||||
lessOrEq: BinaryOperator;
|
||||
greaterOrEq: BinaryOperator;
|
||||
neq: BinaryOperator;
|
||||
and: LogicalOperator;
|
||||
or: LogicalOperator;
|
||||
defined(value: Adaptable<any>): AnimatedNode<0 | 1>;
|
||||
not(value: Adaptable<any>): AnimatedNode<0 | 1>;
|
||||
set(
|
||||
export const add: BinaryOperator;
|
||||
export const sub: BinaryOperator;
|
||||
export const multiply: BinaryOperator;
|
||||
export const divide: BinaryOperator;
|
||||
export const pow: BinaryOperator;
|
||||
export const modulo: BinaryOperator;
|
||||
export const sqrt: UnaryOperator;
|
||||
export const sin: UnaryOperator;
|
||||
export const cos: UnaryOperator;
|
||||
export const exp: UnaryOperator;
|
||||
export const round: UnaryOperator;
|
||||
export const lessThan: BinaryOperator;
|
||||
export const eq: BinaryOperator;
|
||||
export const greaterThan: BinaryOperator;
|
||||
export const lessOrEq: BinaryOperator;
|
||||
export const greaterOrEq: BinaryOperator;
|
||||
export const neq: BinaryOperator;
|
||||
export const and: LogicalOperator;
|
||||
export const or: LogicalOperator;
|
||||
export function defined(value: Adaptable<any>): AnimatedNode<0 | 1>;
|
||||
export function not(value: Adaptable<any>): AnimatedNode<0 | 1>;
|
||||
export function set(
|
||||
valueToBeUpdated: AnimatedValue,
|
||||
sourceNode: Adaptable<number>
|
||||
sourceNode: Adaptable<number>,
|
||||
): AnimatedNode<number>;
|
||||
cond(
|
||||
export function cond(
|
||||
conditionNode: Adaptable<number>,
|
||||
ifNode: Adaptable<number>,
|
||||
elseNode?: Adaptable<number>
|
||||
elseNode?: Adaptable<number>,
|
||||
): AnimatedNode<number>;
|
||||
block<T>(items: ReadonlyArray<Adaptable<T>>): AnimatedNode<T>;
|
||||
call<T>(
|
||||
export function block<T>(
|
||||
items: ReadonlyArray<Adaptable<T>>,
|
||||
): AnimatedNode<T>;
|
||||
export function call<T>(
|
||||
nodes: ReadonlyArray<AnimatedNode<T>>,
|
||||
callback: (values: ReadonlyArray<T>) => void
|
||||
callback: (values: ReadonlyArray<T>) => void,
|
||||
): AnimatedNode<0>;
|
||||
debug<T>(message: string, value: Adaptable<T>): AnimatedNode<T>;
|
||||
onChange(
|
||||
export function debug<T>(
|
||||
message: string,
|
||||
value: Adaptable<T>,
|
||||
): AnimatedNode<T>;
|
||||
export function onChange(
|
||||
value: Adaptable<any>,
|
||||
action: Adaptable<any>
|
||||
action: Adaptable<any>,
|
||||
): AnimatedNode<undefined>;
|
||||
startClock(clock: AnimatedClock): AnimatedNode<0>;
|
||||
always(item: AnimatedNode<any>): AnimatedNode<0>;
|
||||
stopClock(clock: AnimatedClock): AnimatedNode<0>;
|
||||
clockRunning(clock: AnimatedClock): AnimatedNode<0 | 1>;
|
||||
export function startClock(clock: AnimatedClock): AnimatedNode<0>;
|
||||
export function always(item: AnimatedNode<any>): AnimatedNode<0>;
|
||||
export function stopClock(clock: AnimatedClock): AnimatedNode<0>;
|
||||
export function clockRunning(clock: AnimatedClock): AnimatedNode<0 | 1>;
|
||||
// the return type for `event` is a lie, but it's the same lie that
|
||||
// react-native makes within Animated
|
||||
event(
|
||||
export function event(
|
||||
argMapping: ReadonlyArray<Mapping | null>,
|
||||
config?: {}
|
||||
config?: {},
|
||||
): (...args: any[]) => void;
|
||||
|
||||
// derived operations
|
||||
abs(value: Adaptable<number>): AnimatedNode<number>;
|
||||
acc(value: Adaptable<number>): AnimatedNode<number>;
|
||||
color(
|
||||
export function abs(value: Adaptable<number>): AnimatedNode<number>;
|
||||
export function acc(value: Adaptable<number>): AnimatedNode<number>;
|
||||
export function color(
|
||||
r: Adaptable<number>,
|
||||
g: Adaptable<number>,
|
||||
b: Adaptable<number>,
|
||||
a?: Adaptable<number>
|
||||
a?: Adaptable<number>,
|
||||
): AnimatedNode<number>;
|
||||
diff(value: Adaptable<number>): AnimatedNode<number>;
|
||||
diffClamp(
|
||||
export function diff(value: Adaptable<number>): AnimatedNode<number>;
|
||||
export function diffClamp(
|
||||
value: Adaptable<number>,
|
||||
minVal: Adaptable<number>,
|
||||
maxVal: Adaptable<number>
|
||||
maxVal: Adaptable<number>,
|
||||
): AnimatedNode<number>;
|
||||
interpolate(
|
||||
export function interpolate(
|
||||
value: Adaptable<number>,
|
||||
config: InterpolationConfig
|
||||
config: InterpolationConfig,
|
||||
): AnimatedNode<number>;
|
||||
max: BinaryOperator;
|
||||
min: BinaryOperator;
|
||||
Extrapolate: typeof Extrapolate;
|
||||
export const max: BinaryOperator;
|
||||
export const min: BinaryOperator;
|
||||
|
||||
// animations
|
||||
decay(
|
||||
export function decay(
|
||||
clock: AnimatedClock,
|
||||
state: DecayState,
|
||||
config: DecayConfig
|
||||
config: DecayConfig,
|
||||
): AnimatedNode<number>;
|
||||
timing(
|
||||
export function timing(
|
||||
clock: AnimatedClock,
|
||||
state: TimingState,
|
||||
config: TimingConfig
|
||||
config: TimingConfig,
|
||||
): AnimatedNode<number>;
|
||||
spring(
|
||||
export function spring(
|
||||
clock: AnimatedClock,
|
||||
state: SpringState,
|
||||
config: SpringConfig
|
||||
config: SpringConfig,
|
||||
): AnimatedNode<number>;
|
||||
|
||||
// configuration
|
||||
@@ -248,30 +253,30 @@ declare module 'react-native-reanimated' {
|
||||
|
||||
// addWhitelistedNativeProps(props: { [key: string]: true }): void;
|
||||
}
|
||||
const Animated: Animated;
|
||||
|
||||
export default Animated;
|
||||
|
||||
interface EasingStatic {
|
||||
linear: EasingFunction;
|
||||
ease: EasingFunction;
|
||||
quad: EasingFunction;
|
||||
cubic: EasingFunction;
|
||||
poly(n: Adaptable<number>): EasingFunction;
|
||||
sin: EasingFunction;
|
||||
circle: EasingFunction;
|
||||
exp: EasingFunction;
|
||||
elastic(bounciness?: Adaptable<number>): EasingFunction;
|
||||
back(s?: Adaptable<number>): EasingFunction;
|
||||
bounce: EasingFunction;
|
||||
linear: Animated.EasingFunction;
|
||||
ease: Animated.EasingFunction;
|
||||
quad: Animated.EasingFunction;
|
||||
cubic: Animated.EasingFunction;
|
||||
poly(n: Animated.Adaptable<number>): Animated.EasingFunction;
|
||||
sin: Animated.EasingFunction;
|
||||
circle: Animated.EasingFunction;
|
||||
exp: Animated.EasingFunction;
|
||||
elastic(bounciness?: Animated.Adaptable<number>): Animated.EasingFunction;
|
||||
back(s?: Animated.Adaptable<number>): Animated.EasingFunction;
|
||||
bounce: Animated.EasingFunction;
|
||||
bezier(
|
||||
x1: Adaptable<number>,
|
||||
y1: Adaptable<number>,
|
||||
x2: Adaptable<number>,
|
||||
y2: Adaptable<number>
|
||||
): EasingFunction;
|
||||
in(easing: EasingFunction): EasingFunction;
|
||||
out(easing: EasingFunction): EasingFunction;
|
||||
inOut(easing: EasingFunction): EasingFunction;
|
||||
x1: Animated.Adaptable<number>,
|
||||
y1: Animated.Adaptable<number>,
|
||||
x2: Animated.Adaptable<number>,
|
||||
y2: Animated.Adaptable<number>,
|
||||
): Animated.EasingFunction;
|
||||
in(easing: Animated.EasingFunction): Animated.EasingFunction;
|
||||
out(easing: Animated.EasingFunction): Animated.EasingFunction;
|
||||
inOut(easing: Animated.EasingFunction): Animated.EasingFunction;
|
||||
}
|
||||
export const Easing: EasingStatic;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user