File

libs/nx/src/generators/journey/schema.ts

Description

The schema for the journey generator

Index

Properties

Properties

directory (Optional)
Type string
CLI Usage --directory="apps/oe/acm/my-journey"
Description

The root directory for the journey project.

name
Type string
CLI Usage --name="My Journey"
Description

The name of the journey to generate. It will be dasherized and used as project name. If the "directory" option is not specified, it is also used to construct the project's root path by joining the apps directory of your Nx workspace and the project name.

splitJourney (Optional)
Type boolean
CLI Usage --splitJourney=true
Default value false
Description

Whether the split journey config format should be used. More information on different config formats can be found here: https://taly.frameworks.allianz.io/additional-documentation/app-configuration.html#journey-config-files

export interface JourneyGeneratorSchema {
  /**
   * The name of the journey to generate. It will be dasherized and used as project name.
   * If the "directory" option is not specified, it is also used to construct the project's root path by joining the apps directory of your Nx workspace and the project name.
   * @x-prompt Please type the name of the journey
   * @cliUsage --name="My Journey"
   */
  name: string;

  /**
   * The root directory for the journey project.
   * @cliUsage --directory="apps/oe/acm/my-journey"
   */
  directory?: string;

  /**
   * Whether the split journey config format should be used.
   * More information on different config formats can be found here:
   * https://taly.frameworks.allianz.io/additional-documentation/app-configuration.html#journey-config-files
   *
   * @cliUsage --splitJourney=true
   * @default false
   */
  splitJourney?: boolean;
}

results matching ""

    No results matching ""