Class: User

User

new User(theInterface, socket)

Parameters:
Name Type Description
theInterface Interface the interface the user connected through
socket net.Socket the socket the user is attached to
Since:
  • 0.6.0
Source:

Methods

getInterface() → {Interface}

Source:
Returns:
the interface the user connected through
Type
Interface

getSocket() → {net.Socket}

This function is used to get the socket the user is attached to
Source:
Returns:
the socket the user is attached to
Type
net.Socket

getUsername() → {string}

This function is used to get the username of the user. Please note that the username may not have been set when you request it as it's defined when the user executes the "USER " command
Since:
  • 0.6.0
Source:
Returns:
the username of the user if it's been defined
Type
string

setPassword() → {string}

This function is used to get the password of the user. Please note that the password may not have been set when you request it as it's defined when the user executes the "PASS " command
Since:
  • 0.6.0
Source:
Returns:
the password of the user if it's been defined
Type
string