import ESDocUploader from 'esdoc-uploader'

public class | source

ESDocUploader

ESDocUploader, connects with the ESDoc hosting service API in order to generage the documentation for your project.

Constructor Summary

Public Constructor
public	constructor(url: String)

Public Members
public get	url: String The repository url the class will send to the ESDoc API.

Public Methods
public	canUpload(): Boolean Checks whether the repository is valid and the class can start uploading the documentation.
public	upload(callback: UploadCallback) Upload your documentation to the ESDoc API.

Name	Type	Attribute	Description
url	String	optional default: null nullable: true	This is the GitHub repository url. The required format its `git[at]github.com:[author]/[repository].git`. You can also ignore it and it will automatically search for it on your `package.json`.

The repository url the class will send to the ESDoc API.

Checks whether the repository is valid and the class can start uploading the documentation.

Upload your documentation to the ESDoc API.

Name	Type	Attribute	Description
callback	UploadCallback		An optional callback to be executed after everthing is ready.