Files
react/packages/shared/ReactTypes.js
Andrew Clark ad9544f48e Prefix internal context properties with underscore (#12358)
So these aren't mistaken for public properties. Ideally, we'd use
symbols or private fields.
2018-03-12 14:30:47 -07:00

106 lines
2.1 KiB
JavaScript

/**
* Copyright (c) 2014-present, Facebook, Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow
* @providesModule ReactTypes
*/
export type ReactNode =
| React$Element<any>
| ReactCall<any>
| ReactReturn<any>
| ReactPortal
| ReactText
| ReactFragment
| ReactProvider<any>
| ReactConsumer<any>;
export type ReactFragment = ReactEmpty | Iterable<React$Node>;
export type ReactNodeList = ReactEmpty | React$Node;
export type ReactText = string | number;
export type ReactEmpty = null | void | boolean;
export type ReactCall<V> = {
$$typeof: Symbol | number,
type: Symbol | number,
key: null | string,
ref: null,
props: {
props: any,
// This should be a more specific CallHandler
handler: (props: any, returns: Array<V>) => ReactNodeList,
children?: ReactNodeList,
},
};
export type ReactReturn<V> = {
$$typeof: Symbol | number,
type: Symbol | number,
key: null,
ref: null,
props: {
value: V,
},
};
export type ReactProvider<T> = {
$$typeof: Symbol | number,
type: ReactProviderType<T>,
key: null | string,
ref: null,
props: {
value: T,
children?: ReactNodeList,
},
};
export type ReactProviderType<T> = {
$$typeof: Symbol | number,
context: ReactContext<T>,
};
export type ReactConsumer<T> = {
$$typeof: Symbol | number,
type: ReactContext<T>,
key: null | string,
ref: null,
props: {
children: (value: T) => ReactNodeList,
bits?: number,
},
};
export type ReactContext<T> = {
$$typeof: Symbol | number,
Consumer: ReactContext<T>,
Provider: ReactProviderType<T>,
_calculateChangedBits: ((a: T, b: T) => number) | null,
_defaultValue: T,
_currentValue: T,
_changedBits: number,
// DEV only
_currentRenderer?: Object | null,
};
export type ReactPortal = {
$$typeof: Symbol | number,
key: null | string,
containerInfo: any,
children: ReactNodeList,
// TODO: figure out the API for cross-renderer implementation.
implementation: any,
};
export type RefObject = {|
value: any,
|};