Uses of Class
com.vaadin.flow.server.frontend.Options

Packages that use Options

Package	Description
com.vaadin.flow.server.frontend

Uses of Options in com.vaadin.flow.server.frontend

Fields in com.vaadin.flow.server.frontend declared as Options

Modifier and Type	Field	Description
protected Options	NodeUpdater.options

Methods in com.vaadin.flow.server.frontend that return Options

Modifier and Type	Method	Description
Options	Options.copyLocalResources(File localResourcesFolder)	Set local frontend files to be copied from given folder.
Options	Options.copyResources(Set<File> jars)	Sets whether copy resources from classpath to the appropriate npm package folder so as they are available for webpack build.
Options	Options.createMissingPackageJson(boolean create)	Sets whether to create the package file if missing.
Options	Options.enableImportsUpdate(boolean enableImportsUpdate)	Sets whether to enable imports file update.
Options	Options.enableNpmFileCleaning(boolean forceClean)	Deprecated.
Options	Options.enablePackagesUpdate(boolean enablePackagesUpdate)	Sets whether to enable packages and webpack file updates.
Options	Options.populateTokenFileData(elemental.json.JsonObject object)	Fill token file data into the provided object.
Options	Options.setJavaResourceFolder(File javaResourceFolder)	Set the java resources folder to be checked for feature file.
Options	Options.setNodeAutoUpdate(boolean update)	Sets whether it is fine to automatically update the alternate node installation if installed version is older than the current default.
Options	Options.skipDevBundleBuild(boolean skip)	Set to true to skip dev bundle build in case a dev bundle exists.
Options	Options.useByteCodeScanner(boolean byteCodeScanner)	Sets frontend scanner strategy: byte code scanning strategy is used if byteCodeScanner is true, full classpath scanner strategy is used otherwise (by default).
Options	Options.useGlobalPnpm(boolean useGlobalPnpm)	Uses globally installed pnpm tool for frontend packages installation.
Options	Options.withBuildDirectory(String buildDirectory)	Use the specified directory name (inside the project folder) for the build output.
Options	Options.withBundleBuild(boolean bundleBuild)	Whether to run bundle build.
Options	Options.withCiBuild(boolean ciBuild)	Enables ci build.
Options	Options.withCopyTemplates(boolean copyTemplates)	Sets whether copy templates to META-INF/VAADIN/config/templates.
Options	Options.withEmbeddableWebComponents(boolean generateEmbeddableWebComponents)	Sets whether to collect and package WebComponentExporter dependencies.
Options	Options.withEnablePnpm(boolean enable)	Enables pnpm tool.
Options	Options.withFeatureFlags(FeatureFlags featureFlags)
Options	Options.withForceProductionBuild(boolean forceProductionBuild)	Setting this to true will force a build of the production build even if there is a default production bundle that could be used.
Options	Options.withFrontendDirectory(File frontendDirectory)	Sets the directory containing the project's frontend files
Options	Options.withFrontendGeneratedFolder(File frontendGeneratedFolder)	Set the folder where frontend files should be generated.
Options	Options.withFrontendHotdeploy(boolean frontendHotdeploy)	Whether to run with a dev server (when not in production mode).
Options	Options.withHomeNodeExecRequired(boolean requireHomeNodeExec)	Requires node executable to be installed in vaadin home folder.
Options	Options.withJarFrontendResourcesFolder(File jarFrontendResourcesFolder)	Sets the appropriate npm package folder for copying flow resources in jars.
Options	Options.withNodeDownloadRoot(URI nodeDownloadRoot)	Sets the download node.js URL.
Options	Options.withNodeVersion(String nodeVersion)	Sets the node.js version to be used when node.js is installed automatically by Vaadin, for example "v16.0.0".
Options	Options.withPostinstallPackages(List<String> postinstallPackages)	Sets the additional npm packages to run postinstall for.
Options	Options.withProductionMode(boolean productionMode)	Sets the production mode.
Options	Options.withRunNpmInstall(boolean runNpmInstall)	Sets whether run npm install after updating dependencies.
Options	Options.withTokenFile(File tokenFile)	Sets the token file (flow-build-info.json) path.
Options	Options.withWebpack(File webappResourcesDirectory, File resourceOutputDirectory)	Sets the webpack related properties.

Methods in com.vaadin.flow.server.frontend with parameters of type Options

Modifier and Type	Method	Description
static void	BundleUtils.copyPackageLockFromBundle(Options options)	Copy package-lock.json/.yaml file from existing dev-bundle for building new bundle.
TaskGenerateEndpoint	EndpointGeneratorTaskFactory.createTaskGenerateEndpoint(Options options)	Create a task for generating TS files based.
TaskGenerateOpenAPI	EndpointGeneratorTaskFactory.createTaskGenerateOpenAPI(Options options)	Create a task for generating OpenAPI spec.
static boolean	BundleValidationUtil.frontendImportsFound(elemental.json.JsonObject statsJson, Options options, ClassFinder finder, FrontendDependenciesScanner frontendDependencies)
static elemental.json.JsonObject	BundleValidationUtil.getDefaultPackageJson(Options options, FrontendDependenciesScanner frontendDependencies, ClassFinder finder, elemental.json.JsonObject packageJson)
static elemental.json.JsonObject	BundleValidationUtil.getPackageJson(Options options, FrontendDependenciesScanner frontendDependencies, ClassFinder finder)	Get the package.json file from disk if available else generate in memory.
static boolean	BundleValidationUtil.needsBuild(Options options, FrontendDependenciesScanner frontendDependencies, ClassFinder finder, Mode mode)	Checks if an application needs a new frontend bundle.
static boolean	ThemeValidationUtil.themeConfigurationChanged(Options options, elemental.json.JsonObject statsJson, FrontendDependenciesScanner frontendDependencies, ClassFinder finder)

Constructors in com.vaadin.flow.server.frontend with parameters of type Options

Modifier	Constructor	Description
	GenerateMainImports(ClassFinder classFinder, FrontendDependenciesScanner frontendDepScanner, Options options, elemental.json.JsonObject statsJson)
	NodeTasks(Options options)	Initialize tasks with the given options.
protected	NodeUpdater(ClassFinder finder, FrontendDependenciesScanner frontendDependencies, Options options)	Constructor.
	TaskInstallFrontendBuildPlugins(Options options)	Copy Flow webpack plugins into PLUGIN_TARGET under the build directory.
	TaskPrepareProdBundle(Options options)