Logo for jsDocs.io

@react-native-community/cli-platform-android

  • Version 10.1.3
  • Published
  • 199 kB
  • 5 dependencies
  • MIT license

Install

npm i @react-native-community/cli-platform-android
yarn add @react-native-community/cli-platform-android
pnpm add @react-native-community/cli-platform-android

Overview

Overview not available.

Index

Variables

Functions

Variables

variable commands

const commands: (
    | { name: string; description: string; func: () => Promise<void> }
    | {
          name: string;
          description: string;
          func: (
              _argv: string[],
              config: any,
              args: import('./runAndroid').Flags
          ) => Promise<void>;
          options: (
              | {
                    name: string;
                    description: string;
                    default?: undefined;
                    parse?: undefined;
                }
              | {
                    name: string;
                    default: string | number;
                    parse: NumberConstructor;
                    description?: undefined;
                }
              | {
                    name: string;
                    description: string;
                    default: string | undefined;
                    parse?: undefined;
                }
              | {
                    name: string;
                    description: string;
                    parse: (val: string) => string[];
                    default?: undefined;
                }
              | {
                    name: string;
                    description: string;
                    default: boolean;
                    parse?: undefined;
                }
          )[];
      }
)[];

    Functions

    function dependencyConfig

    dependencyConfig: (
        root: string,
        userConfig?: AndroidDependencyParams | null
    ) => AndroidDependencyConfig | null;

    • Same as projectConfigAndroid except it returns different config that applies to packages only

    function getAndroidProject

    getAndroidProject: (config: Config) => any;

      function getPackageName

      getPackageName: (
          manifestPath: string | null,
          buildGradlePath: string | null
      ) => string;

      • Get the package name/namespace of the running React Native app

        Parameter manifestPath

        The path to the AndroidManifest.xml

        Parameter buildGradlePath

        The path to the build.gradle[.kts] file.

      function projectConfig

      projectConfig: (
          root: string,
          userConfig?: AndroidProjectParams
      ) => AndroidProjectConfig | null;

      • Gets android project config by analyzing given folder and taking some defaults specified by user into consideration

      Package Files (4)

      Dependencies (5)

      Dev Dependencies (4)

      Peer Dependencies (0)

      No peer dependencies.

      Badge

      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@react-native-community/cli-platform-android.

      • Markdown
        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@react-native-community/cli-platform-android)
      • HTML
        <a href="https://www.jsdocs.io/package/@react-native-community/cli-platform-android"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>