Back to Top

doxdox-workspace master

shirt()

A module representing a shirt.

Returns

Void

color()

The module's color property.

Returns

Void

Turtleneck(size)

Create a new Turtleneck.

Parameters

Name Type Description
size string
  • The size (XS, S, M, L, XL, or XXL).

Returns

Void

this.size()

The class's size property.

Returns

Void

define()

A module representing a jacket.

Returns

Void

Jacket()

Create a new jacket.

Returns

Void

Jacket.zip()

Zip up the jacket.

Returns

Void

define()

Module representing a shirt.

Returns

Void

color()

Color.

Returns

Void

size()

Size.

Returns

Void

module.zip(jacket)

Zip up a jacket.

Parameters

Name Type Description
jacket Jacket
  • The jacket to zip up.

Returns

Void

utils()

Utility functions to ease working with DOM elements.

Returns

Void

getStyleProperty(element, propertyName)

Get the value of a property on an element.

Parameters

Name Type Description
element HTMLElement
  • The element.
propertyName string
  • The name of the property.

Returns

The value of the property.

utils.isInHead(element)

Determine if an element is in the document head.

Parameters

Name Type Description
element HTMLElement
  • The element.

Returns

boolean

Set to true if the element is in the document head, false otherwise.

tag()

Returns

Void

Tag(tagName)

Create a new Tag.

Parameters

Name Type Description
tagName string
  • The name of the tag.

Returns

Void

Book(title, author)

Represents a book.

Parameters

Name Type Description
title string
  • The title of the book.
author string
  • The author of the book.

Returns

Void

foo()

This is a description of the foo function.

Returns

Void

exports.button()

Button the shirt.

Returns

Void

exports.unbutton()

Unbutton the shirt.

Returns

Void

wash()

Wash the shirt.

Returns

Void

wash()

Wash the shirt.

Returns

Void

module.exports()

Color mixer.

Returns

Void

blend(color1, color2)

Blend two colors together.

Parameters

Name Type Description
color1 string
  • The first color, in hexadecimal format.
color2 string
  • The second color, in hexadecimal format.

Returns

string

The blended color.

darken(color, percent)

Darken a color by the given percentage.

Parameters

Name Type Description
color string
  • The color, in hexadecimal format.
percent number
  • The percentage, ranging from 0 to 100.

Returns

string

The darkened color.

module.exports()

Color mixer.

Returns

Void

blend(color1, color2)

Blend two colors together.

Parameters

Name Type Description
color1 string
  • The first color, in hexadecimal format.
color2 string
  • The second color, in hexadecimal format.

Returns

string

The blended color.

darken(color, percent)

Darken a color by the given percentage.

Parameters

Name Type Description
color string
  • The color, in hexadecimal format.
percent number
  • The percentage, ranging from 0 to 100.

Returns

string

The darkened color.

module.exports(color1, color2)

Blend two colors together.

Parameters

Name Type Description
color1 string
  • The first color, in hexadecimal format.
color2 string
  • The second color, in hexadecimal format.

Returns

string

The blended color.

module.exports()

Create a color mixer.

Returns

Void

module.exports()

Module representing the word of the day.

Returns

Void

mixer()

Color mixer.

Returns

Void

blend(color1, color2)

Blend two colors together.

Parameters

Name Type Description
color1 string
  • The first color, in hexadecimal format.
color2 string
  • The second color, in hexadecimal format.

Returns

string

The blended color.

this.Book(title)

Create a new Book.

Parameters

Name Type Description
title string
  • The title of the book.

Returns

Void

this.title()

The title of the book.

Returns

Void

findFileInPath([input, fileName])

Finds file in path.

console.log(await findFileInPath('./', 'package.json'));
console.log(await findFileInPath('../', 'package.json'));
console.log(await findFileInPath('~/git/github/doxdox/', '.package.json'));

Parameters

Name Type Description
input string

Directory to check for file.

 Optional
fileName string

= 'package.json'] File name to check for.

 Optional

Returns

Promise.<string|null>

Path to package.json file.

getRootDirPath([url])

Get the root directory of the package, supplied path or URL.

Parameters

Name Type Description
url string

Optional path or URL.

 Optional

Returns

string

Directory path.

getCurrentWorkingDirectory()

Get the current working directory.

Returns

string

Directory path.

new Point()

Class representing a point.

Returns

Void

Point.constructor(x, y)

Create a point.

Parameters

Name Type Description
x number
  • The x value.
y number
  • The y value.

Returns

Void

Point.getX()

Get the x value.

Returns

number

The x value.

Point.getY()

Get the y value.

Returns

number

The y value.

Point.fromString(str)

Convert a string containing two comma-separated numbers into a point.

Parameters

Name Type Description
str string
  • The string containing two comma-separated numbers.

Returns

Point

A Point object.

Point()

Class representing a point.

Returns

Void

new Dot()

Class representing a dot.

Returns

Void

Dot.constructor(x, y, width)

Create a dot.

Parameters

Name Type Description
x number
  • The x value.
y number
  • The y value.
width number
  • The width of the dot, in pixels.

Returns

Void

Dot.getWidth()

Get the dot's width.

Returns

number

The dot's width, in pixels.

blend(color1, color2)

Blend two colors together.

Parameters

Name Type Description
color1 string
  • The first color, in hexadecimal format.
color2 string
  • The second color, in hexadecimal format.

Returns

string

The blended color.

getRootDirPath([url])

Get the root directory of the package, supplied path or URL.

Parameters

Name Type Description
url string

Optional path or URL.

 Optional

Returns

string

Directory path.

getCurrentWorkingDirectory()

Get the current working directory.

Returns

string

Directory path.

foo()

This is a description of the foo function.

Returns

Void

sayHello(somebody)

Parameters

Name Type Description
somebody

Returns

Void

sayHello(somebody)

Parameters

Name Type Description
somebody string

Returns

Void

sayHello(somebody)

Parameters

Name Type Description
somebody string

Somebody's name.

Returns

Void

sayHello(somebody)

Parameters

Name Type Description
somebody string
  • Somebody's name.

Returns

Void

Project.assign(employee)

Assign the project to an employee.

Parameters

Name Type Description
employee Object
  • The employee who is responsible for the project.
employee.name string
  • The name of the employee.
employee.department string
  • The employee's department.

Returns

Void

Project.assign(employee)

Assign the project to an employee.

Parameters

Name Type Description
employee Object
  • The employee who is responsible for the project.
employee.name string
  • The name of the employee.
employee.department string
  • The employee's department.

Returns

Void

Project.assign(employees)

Assign the project to a list of employees.

Parameters

Name Type Description
employees Array.<Object>
  • The employees who are responsible for the project.
employees.name string
  • The name of an employee.
employees.department string
  • The employee's department.

Returns

Void

sayHello([somebody])

Parameters

Name Type Description
somebody string
  • Somebody's name.
 Optional

Returns

Void

sayHello([somebody])

Parameters

Name Type Description
somebody string
  • Somebody's name.
 Optional

Returns

Void

sayHello([somebody=John])

Parameters

Name Type Description
somebody=John string

Doe] - Somebody's name.

 Optional

Returns

Void

sayHello([somebody=John])

Parameters

Name Type Description
somebody=John string Array.<string>

Doe] - Somebody's name, or an array of names.

 Optional

Returns

Void

sayHello(somebody)

Parameters

Name Type Description
somebody
  • Whatever you want.

Returns

Void

sum(num)

Returns the sum of all numbers passed to the function.

Parameters

Name Type Description
num number
  • A positive or negative number.

Returns

Void

new Point()

Class representing a point.

Returns

Void

Point.constructor(x, y)

Create a point.

Parameters

Name Type Description
x number
  • The x value.
y number
  • The y value.

Returns

Void

Point.getX()

Get the x value.

Returns

number

The x value.

Point.getY()

Get the y value.

Returns

number

The y value.

publicMethod()

Returns

Void

publicMethod()

Returns

Void

privateMethod() private function

Returns

Void

privateMethod() private function

Returns

Void

findFileInPath([input, fileName])

Finds file in path.

console.log(await findFileInPath('./', 'package.json'));
console.log(await findFileInPath('../', 'package.json'));
console.log(await findFileInPath('~/git/github/doxdox/', '.package.json'));

Parameters

Name Type Description
input string

Directory to check for file.

 Optional
fileName string

= 'package.json'] File name to check for.

 Optional

Returns

Promise.<string|null>

Path to package.json file.

getRootDirPath([url])

Get the root directory of the package, supplied path or URL.

Parameters

Name Type Description
url string

Optional path or URL.

 Optional

Returns

string

Directory path.

getCurrentWorkingDirectory()

Get the current working directory.

Returns

string

Directory path.

getRootDirPath([url])

Get the root directory of the package, supplied path or URL.

Parameters

Name Type Description
url string

Optional path or URL.

 Optional

Returns

string

Directory path.

getCurrentWorkingDirectory()

Get the current working directory.

Returns

string

Directory path.

findFileInPath([input, fileName])

Finds file in path.

console.log(await findFileInPath('./', 'package.json'));
console.log(await findFileInPath('../', 'package.json'));
console.log(await findFileInPath('~/git/github/doxdox/', '.package.json'));

Parameters

Name Type Description
input string

Directory to check for file.

 Optional
fileName string

= 'package.json'] File name to check for.

 Optional

Returns

Promise.<string|null>

Path to package.json file.

getRootDirPath([url])

Get the root directory of the package, supplied path or URL.

Parameters

Name Type Description
url string

Optional path or URL.

 Optional

Returns

string

Directory path.

getCurrentWorkingDirectory()

Get the current working directory.

Returns

string

Directory path.

getRootDirPath([url])

Get the root directory of the package, supplied path or URL.

Parameters

Name Type Description
url string

Optional path or URL.

 Optional

Returns

string

Directory path.

getCurrentWorkingDirectory()

Get the current working directory.

Returns

string

Directory path.

findFileInPath([input, fileName])

Finds file in path.

console.log(await findFileInPath('./', 'package.json'));
console.log(await findFileInPath('../', 'package.json'));
console.log(await findFileInPath('~/git/github/doxdox/', '.package.json'));

Parameters

Name Type Description
input string

Directory to check for file.

 Optional
fileName string

= 'package.json'] File name to check for.

 Optional

Returns

Promise.<string|null>

Path to package.json file.

getRootDirPath([url])

Get the root directory of the package, supplied path or URL.

Parameters

Name Type Description
url string

Optional path or URL.

 Optional

Returns

string

Directory path.

getCurrentWorkingDirectory()

Get the current working directory.

Returns

string

Directory path.

getRootDirPath([url])

Get the root directory of the package, supplied path or URL.

Parameters

Name Type Description
url string

Optional path or URL.

 Optional

Returns

string

Directory path.

getCurrentWorkingDirectory()

Get the current working directory.

Returns

string

Directory path.