@types/react-native-torch

Installation

npm install --save @types/react-native-torch

Summary

This package contains type definitions for react-native-torch (https://github.com/ludo/react-native-torch#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-native-torch.

index.d.ts

declare const Torch: {
    /**
     * Used to turn on or off the torch. Pass `true` to turn on and `false` to
     * turn off
     *
     * @example
     *  Torch.switchState(true); // Turn ON
     *  Torch.switchState(false); // Turn OFF
     *
     * @param newState `true` for on or `false` for off
     */
    switchState(newState: boolean): void;

    /**
     * On android, we need to ask for permissions before being able to turn on/off
     * the torch
     *
     * @example
     *  if (Platform.OS === 'ios') {
     *    Torch.switchState(this.isTorchOn);
     *  } else {
     *    const cameraAllowed = await Torch.requestCameraPermission(
     *      'Camera Permissions', // dialog title
     *      'We require camera permissions to use the torch on the back of your phone.' // dialog body
     *    );
     *
     *    if (cameraAllowed) {
     *      Torch.switchState(this.isTorchOn);
     *    }
     *  }
     *
     * @param dialogTitle The title of the permissions dialog
     * @param dialogBody The body text of the permissions dialog
     */
    requestCameraPermission(dialogTitle: string, dialogBody: string): Promise<boolean>;
};

export default Torch;

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: none

Credits

These definitions were written by Ben Lorantfy.