API Docs for: 0.0.4
Show:

Algorithm Class

Defined in: lib\algorithms\algorithm.js:5
Module: Algorithms

Constructor

Algorithm

(
  • name
  • options
)

Defined in lib\algorithms\algorithm.js:5

Parameters:

  • name String
  • options Object

Item Index

Methods

Properties

Methods

duration

(
  • [time]
)
Number

Defined in lib\algorithms\algorithm.js:59

Parameters:

  • [time] Number optional

    Duration for the sprint in milliseconds.

Returns:

Number:

first

(
  • [start]
)
Number

Defined in lib\algorithms\algorithm.js:27

The first day of the sprint.

0: Sunday 1: Monday
2: Tuesday ...

Parameters:

  • [start] Number optional

Returns:

Number:

points

(
  • [expected]
)
Number

Defined in lib\algorithms\algorithm.js:46

Parameters:

  • [expected] Number optional

Returns:

Number:

process

(
  • board
)
Promise | > | Board

Defined in lib\algorithms\algorithm.js:72

Parameters:

Returns:

Promise | > | Board:

Properties

name

String

Defined in lib\algorithms\algorithm.js:20