Sphinx

Sphinx

Sphinx encapsulates the functionality to create various API wrapper objects.

Constructor

new Sphinx(authopt, apiBaseopt)

Create a new Sphinx.

Source:
Parameters:
Name Type Attributes Default Description
auth Requestable.auth <optional>

the credentials to authenticate to Sphinx. If auth is not provided requests will be made unauthenticated
apiBase string <optional>
 https://sphinx.bluehack.net

the base Sphinx API URL

Methods

getAuthenticate(useropt) → {User}

Create a new User wrapper

Source:
Parameters:
Name Type Attributes Description
user string <optional>

the name of the user to get information about leave undefined for the authenticated user
Returns:
Type:
User