Logo for jsDocs.io

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

  • Version 12.1.1
  • Published
  • 219 kB
  • 6 dependencies
  • MIT license

Install

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

Overview

This package is part of the [React Native CLI](../../README.md). It contains commands for managing iOS part of React Native app.

Index

Variables

Functions

Variables

variable commands

const commands: (
    | {
          name: string;
          description: string;
          func: (
              _argv: string[],
              _ctx: any,
              args: { interactive: boolean }
          ) => Promise<void>;
          options: { name: string; description: string }[];
      }
    | {
          name: string;
          description: string;
          func: (
              _: string[],
              ctx: any,
              args: import('./runIOS').FlagsT
          ) => Promise<void>;
          examples: { desc: string; cmd: string }[];
          options: (
              | { name: string; description: string; parse?: undefined }
              | {
                    name: string;
                    description: string;
                    parse: (val: string) => string[];
                }
              | {
                    name: string;
                    default: string | number;
                    parse: NumberConstructor;
                    description?: undefined;
                }
              | {
                    name: string;
                    description: string;
                    default: string | undefined;
                    parse?: undefined;
                }
          )[];
      }
    | {
          name: string;
          description: string;
          func: (
              _: string[],
              ctx: any,
              args: import('./buildIOS/buildOptions').BuildFlags
          ) => Promise<string>;
          examples: { desc: string; cmd: string }[];
          options: (
              | { name: string; description: string; parse?: undefined }
              | {
                    name: string;
                    description: string;
                    parse: (val: string) => string[];
                }
          )[];
      }
)[];

    variable findPodfilePaths

    const findPodfilePaths: (cwd: string) => string[];

      Functions

      function dependencyConfig

      dependencyConfig: (
          folder: string,
          userConfig?: IOSDependencyParams | null
      ) => IOSDependencyConfig | null;

        function getArchitecture

        getArchitecture: (iosSourceDir: string) => Promise<boolean>;

          function installPods

          installPods: (loader?: Ora, options?: PodInstallOptions) => Promise<void>;

            function projectConfig

            projectConfig: (
                folder: string,
                userConfig: IOSProjectParams
            ) => IOSProjectConfig | null;

            • Returns project config by analyzing given folder and applying some user defaults when constructing final object

            Package Files (5)

            Dependencies (6)

            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-ios.

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