JSDoc: Class: HarrogateClient

new HarrogateClient(ip)

Creates a HarrogateClient object

Parameters:

Name	Type	Description
`ip`	string	The ip adress/url of the Harrogate Server

Source:

index.js, line 209

Members

url :string

url of the Harrogate Server

Type:

string

Source:

index.js, line 218

Methods

addFile(username, project, dir, name) → {Promise.<File, error>}

Adds a file.

Parameters:

Name	Type	Description
`username`	string	name of the user
`project`	string	name of the project
`dir`	string	name of the directory
`name`	string	name of the file

Source:

index.js, line 487

Returns:

Type: Promise.<File, error>

addFilePath(filepath) → {Promise.<File, error>}

Adds a file.

Parameters:

Name	Type	Description
`filepath`	string	path of the file

Source:

index.js, line 511

Returns:

Type: Promise.<File, error>

addProject(username, projectname) → {Promise.<Project, error>}

Adds a project.

Parameters:

Name	Type	Description
`username`	string	name of the user
`projectname`	string	name of the new project

Source:

index.js, line 343

Returns:

Type: Promise.<Project, error>

addUser(username) → {Promise.<User, error>}

Adds a new Uuer.

Parameters:

Name	Type	Description
`username`	string	name of the user

Source:

index.js, line 250

Returns:

Type: Promise.<User, error>

allProjects() → {Promise.<Array.<Project>, error>}

Gets the projects of all users.

Source:

index.js, line 289

Returns:

Type: Promise.<Array.<Project>, error>

compile(username, projectname) → {Promise.<{stdout: string, stderr: string}, error>}

Compiles a project.

Parameters:

Name	Type	Description
`username`	string	name of the user
`projectname`	string	name of the project

Source:

index.js, line 389

Returns:

Type: Promise.<{stdout: string, stderr: string}, error>

deleteFile(username, project, dir, name) → {Promise.<void, error>}

Deletes a file.

Parameters:

Name	Type	Description
`username`	string	name of the user
`project`	string	name of the project
`dir`	string	name of the directory
`name`	string	name of the file

Source:

index.js, line 525

Returns:

Type: Promise.<void, error>

deleteFilePath(filepath) → {Promise.<void, error>}

Deletes a file.

Parameters:

Name	Type	Description
`filepath`	string	path of the file

Source:

index.js, line 534

Returns:

Type: Promise.<void, error>

deleteProject(username, projectname) → {Promise.<void, error>}

Deletes a project.

Parameters:

Name	Type	Description
`username`	string	name of the user
`projectname`	string	name of the project

Source:

index.js, line 372

Returns:

Type: Promise.<void, error>

deleteUser(username) → {Promise.<void, error>}

Deletes an user.

Parameters:

Name	Type	Description
`username`	string	name of the user

Source:

index.js, line 272

Returns:

Type: Promise.<void, error>

getProjectInformation(username, project) → {Promise.<ProjectInfo, error>}

Gets information of a project.

Parameters:

Name	Type	Description
`username`	string	name of the user
`project`	string	name of the project

Source:

index.js, line 412

Returns:

Type: Promise.<ProjectInfo, error>

getProjects(username) → {Promise.<Array.<Project>, error>}

Gets the projects of a specific user.

Parameters:

Name	Type	Description
`username`	string	name of the user

Source:

index.js, line 316

Returns:

Type: Promise.<Array.<Project>, error>

getUsers() → {Promise.<Array.<User>, error>}

Gets an array of all users.

Source:

index.js, line 226

Returns:

Type: Promise.<Array.<User>, error>

loadFile(username, project, dir, name) → {Promise.<string, error>}

Loads the content of a file.

Parameters:

Name	Type	Description
`username`	string	name of the user
`project`	string	name of the project
`dir`	string	name of the directory
`name`	string	name of the file

Source:

index.js, line 457

Returns:

Type: Promise.<string, error>

loadFilePath(filepath) → {Promise.<string, error>}

Loads the content of a file.

Parameters:

Name	Type	Description
`filepath`	string	path of the file

Source:

index.js, line 466

Returns:

Type: Promise.<string, error>

saveFile(username, project, dir, name, content) → {Promise.<void, error>}

Saves a file.

Parameters:

Name	Type	Description
`username`	string	name of the user
`project`	string	name of the project
`dir`	string	name of the directory
`name`	string	name of the file
`content`	string	contant to save

Source:

index.js, line 551

Returns:

Type: Promise.<void, error>

saveFilePath(filepath, content) → {Promise.<void, error>}

Saves a file.

Parameters:

Name	Type	Description
`filepath`	string	path of the file
`content`	string	contant to save

Source:

index.js, line 561

Returns:

Type: Promise.<void, error>