@types/react-native/Codegen.d.ts

TypeScript definitions for react-native

declare module 'react-native/Libraries/Utilities/codegenNativeCommands' {
    export interface Options<T extends string> {
        readonly supportedCommands: ReadonlyArray<T>;
    }

    function codegenNativeCommands<T extends object>(options: Options<keyof T extends string ? keyof T : never>): T;

    export default codegenNativeCommands;
}

declare module 'react-native/Libraries/Utilities/codegenNativeComponent' {
    import type { HostComponent } from 'react-native';

    export interface Options {
        readonly interfaceOnly?: boolean;
        readonly paperComponentName?: string;
        readonly paperComponentNameDeprecated?: string;
        readonly excludedPlatforms?: ReadonlyArray<'iOS' | 'android'>;
    }

    export type NativeComponentType<T> = HostComponent<T>;

    function codegenNativeComponent<Props extends object>(
        componentName: string,
        options?: Options,
    ): NativeComponentType<Props>;

    export default codegenNativeComponent;
}

declare module 'react-native/Libraries/Types/CodegenTypes' {
    import type { NativeSyntheticEvent } from 'react-native';

    // Event types
    // We're not using the PaperName, it is only used to codegen view config settings

    export type BubblingEventHandler<T, PaperName extends string | never = never> = (
        event: NativeSyntheticEvent<T>,
    ) => void | Promise<void>;
    export type DirectEventHandler<T, PaperName extends string | never = never> = (
        event: NativeSyntheticEvent<T>,
    ) => void | Promise<void>;

    // Prop types
    export type Double = number;
    export type Float = number;
    export type Int32 = number;
    export type UnsafeObject = object;

    type DefaultTypes = number | boolean | string | ReadonlyArray<string>;
    // Default handling, ignore the unused value
    // we're only using it for type checking
    //
    // TODO: (rickhanlonii) T44881457 If a default is provided, it should always be optional
    //  but that is currently not supported in the codegen since we require a default

    export type WithDefault<Type extends DefaultTypes, Value extends Type | string | undefined | null> =
        | Type
        | undefined
        | null;
}