API Docs for: 0.9.0
Show:

StorageAdapter Class

Defined in: lib/storageAdapter/storageAdapter.js:7

Abstract storage adapter

Methods

archiveApprovedScreen

(
  • name
  • image
)
Promise

Defined in lib/storageAdapter/storageAdapter.js:140

Archives a specific approved screen

Parameters:

  • name String

    Name of approved screen

  • image PNGImage

    Screen to archive

Returns:

Promise:

archiveBuildScreen

(
  • name
  • image
)
Promise

Defined in lib/storageAdapter/storageAdapter.js:174

Archives a specific build screen

Parameters:

  • name String

    Name of build screen

  • image PNGImage

    Screen to archive

Returns:

Promise:

archiveCurrentApprovedScreen

(
  • name
  • image
)
Promise

Defined in lib/storageAdapter/storageAdapter.js:106

Archives a specific currently approved screen

Parameters:

  • name String

    Name of approved screen

  • image PNGImage

    Screen to archive

Returns:

Promise:

archiveHighlightScreen

(
  • name
  • image
)

Defined in lib/storageAdapter/storageAdapter.js:208

Archives a specific highlight screen

Parameters:

  • name String

    Name of highlight screen

  • image PNGImage

    Screen to archive

getApprovedScreen

(
  • name
)
Promise

Defined in lib/storageAdapter/storageAdapter.js:129

Gets a specific approved screen

Parameters:

  • name String

    Name of approved screen

Returns:

Promise:

With {PNGImage} Approved screen

getApprovedScreenNames

() Promise

Defined in lib/storageAdapter/storageAdapter.js:119

Gets a list of approve screen names

Returns:

Promise:

With {string[]} List of approved screen names

getBuildScreen

(
  • name
)
Promise

Defined in lib/storageAdapter/storageAdapter.js:163

Gets a specific build screen

Parameters:

  • name String

    Name of build screen

Returns:

Promise:

With {PNGImage}

getBuildScreenNames

() Promise

Defined in lib/storageAdapter/storageAdapter.js:153

Gets a list of build screen names

Returns:

Promise:

With {string[]} List of build screen names

getCurrentApprovedScreen

(
  • name
)
Promise

Defined in lib/storageAdapter/storageAdapter.js:95

Gets a specific currently approved screen

Parameters:

  • name String

    Name of approved screen

Returns:

Promise:

With {PNGImage} Approved screen

getCurrentApprovedScreenNames

() Promise

Defined in lib/storageAdapter/storageAdapter.js:85

Gets a list of currently approve screen names

Returns:

Promise:

With {string[]} List of approved screen names

getHighlightScreen

(
  • name
)
Promise

Defined in lib/storageAdapter/storageAdapter.js:197

Gets a specific highlight screen

Parameters:

  • name String

    Name of build screen

Returns:

Promise:

With {PNGImage} Build screen

getHighlightScreenNames

() Promise

Defined in lib/storageAdapter/storageAdapter.js:187

Gets a list of build highlight names

Returns:

Promise:

With {string[]} List of build screen names

getPromise

() Promise

Defined in lib/storageAdapter/storageAdapter.js:45

Gets the source-adapter promise

Returns:

Promise:

initialize

()

Defined in lib/storageAdapter/storageAdapter.js:36

Initializes the source-adapter

setBuild

(
  • build
)

Defined in lib/storageAdapter/storageAdapter.js:75

Sets the build information

Parameters:

setPromise

(
  • promise
)

Defined in lib/storageAdapter/storageAdapter.js:55

Sets the promise

Parameters:

  • promise Promise

Properties

TYPE

String

Defined in lib/storageAdapter/storageAdapter.js:221

Type of class