io.jooby.node

Class NodeModule

java.lang.Object

io.jooby.node.NodeModule

All Implemented Interfaces:

Extension

Direct Known Subclasses:

NpmModule, YarnModule

public abstract class NodeModule
extends Object
implements Extension

Base class for Npm and Yarn installer.

Since:

2.8.0

Author:

edgar

Method Summary

Modifier and Type	Method and Description
NodeModule	execute(String cmd, String... args) Execute a node task (without blocking the caller thread).
NodeModule	executeOnce(String cmd, String... args) Run a task once per JVM instance.
void	install(Jooby application)
NodeModule	installDirectory(Path installDirectory) Set install directory where to save the node executable (node/node).
NodeModule	workDirectory(Path workDirectory) Set working directory (location of package.json).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jooby.Extension

lateinit

Method Detail

workDirectory

@Nonnull
public NodeModule workDirectory(@Nonnull
                                         Path workDirectory)

Set working directory (location of package.json).

Parameters:

workDirectory - Work directory.

Returns:

This module.

installDirectory

@Nonnull
public NodeModule installDirectory(@Nonnull
                                            Path installDirectory)

Set install directory where to save the node executable (node/node).

Parameters:

installDirectory - Location where to save the node executable (node/node).

Returns:

This module.

execute

@Nonnull
public NodeModule execute(@Nonnull
                                   String cmd,
                                   @Nonnull
                                   String... args)

Execute a node task (without blocking the caller thread).

Parameters:

cmd - Command.

args - Arguments.

Returns:

This module.

executeOnce

@Nonnull
public NodeModule executeOnce(@Nonnull
                                       String cmd,
                                       @Nonnull
                                       String... args)

Run a task once per JVM instance. Specially created for joobyRun to supports application restart (hot reload) and long running node processes (like a web server).

Parameters:

cmd - Command.

args - Arguments.

Returns:

This module.

install

public void install(@Nonnull
                    Jooby application)
             throws Exception

Specified by:

install in interface Extension

Throws:

Exception