User

Source: src/jix/targets.js#L71-115

Class representing a user on a host.

new User(host, name, info)

User instances are typically created automatically by Host constructor.

Parameters:

  • host (Host, required) - The host this user belongs to
  • name (string, required) - Username
  • info (Object, required) - User information object

Properties

  • name (string) - Username
  • host (Host) - The associated host
  • home (string) - Home directory path
  • uid (string) - User ID
  • gid (string) - Group ID
  • shell (string) - Default shell path

install(fn)

Source: src/jix/targets.js#L109-114

Execute a function with this user as the target context.

Parameters:

  • fn (EffectFn) - Function that receives the user as argument

Returns: The return value of fn