Function ciPlatform

  • ciPlatform(env?): {
        isCI: true;
        metadata: Metadata;
        name: string;
    } | {
        isCI: false;
        metadata?: undefined;
        name?: undefined;
    }

  • Gets info on the CI platform the CLI is running on, if applicable.

    Parameters

    • env: ProcessEnv = process.env

      The environment variables from the environment of the current process.

    Returns {
        isCI: true;
        metadata: Metadata;
        name: string;
    } | {
        isCI: false;
        metadata?: undefined;
        name?: undefined;
    }

    The CI platform info.

Settings

Member Visibility

Theme