API Docs for: 0.9.0
Show:

FileStorageAdapter Class

Extends StorageAdapter
Defined in: lib/storageAdapter/fileStorageAdapter.js:13

File storage adapter

Constructor

FileStorageAdapter

(
  • options
)

Defined in lib/storageAdapter/fileStorageAdapter.js:13

Parameters:

Methods

_getApprovedPath

() String private

Defined in lib/storageAdapter/fileStorageAdapter.js:169

Gets the approved path

Returns:

String:

_getBuildPath

() String private

Defined in lib/storageAdapter/fileStorageAdapter.js:180

Gets the build path

Returns:

String:

_getHighlightPath

() String private

Defined in lib/storageAdapter/fileStorageAdapter.js:191

Gets the highlight path

Returns:

String:

_getPath

() String private

Defined in lib/storageAdapter/fileStorageAdapter.js:157

Gets the processing path

Returns:

String:

_pngFilter

(
  • filename
)
Boolean private

Defined in lib/storageAdapter/fileStorageAdapter.js:144

List filter for png extensions

Parameters:

Returns:

Boolean:

_prepareFolder

() private

Defined in lib/storageAdapter/fileStorageAdapter.js:56

Prepares the output folder

_readDir

(
  • path
)
String[] private

Defined in lib/storageAdapter/fileStorageAdapter.js:117

Reads a directory an returns all files found in the folder

Parameters:

Returns:

String[]:

_readDirAndFilter

(
  • path
)
String[] private

Defined in lib/storageAdapter/fileStorageAdapter.js:129

Reads a directory and filters for png files, removing the extensions

Parameters:

Returns:

String[]:

_readImage

(
  • path
)
Promise private

Defined in lib/storageAdapter/fileStorageAdapter.js:74

Reads an image and returns a promise

Parameters:

Returns:

Promise:

With {PNGImage} Image

_writeImage

(
  • path
  • image
)
Promise private

Defined in lib/storageAdapter/fileStorageAdapter.js:95

Writes an image and returns a promise

Parameters:

Returns:

Promise:

archiveApprovedScreen

(
  • name
  • image
)
Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:267

Archives a specific approved screen

Parameters:

  • name String

    Name of approved screen

  • image PNGImage

    Screen to archive

Returns:

Promise:

archiveBuildScreen

(
  • name
  • image
)
Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:307

Archives a specific build screen

Parameters:

  • name String

    Name of build screen

  • image PNGImage

    Screen to archive

Returns:

Promise:

archiveCurrentApprovedScreen

(
  • name
  • image
)
Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:228

Archives a specific currently approved screen

Parameters:

  • name String

    Name of approved screen

  • image PNGImage

    Screen to archive

Returns:

Promise:

archiveHighlightScreen

(
  • name
  • image
)
Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:347

Archives a specific highlight screen

Parameters:

  • name String

    Name of highlight screen

  • image PNGImage

    Screen to archive

Returns:

Promise:

getApprovedScreen

(
  • name
)
Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:254

Gets a specific approved screen

Parameters:

  • name String

    Name of approved screen

Returns:

Promise:

With {PNGImage} Approved screen

getApprovedScreenNames

() Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:242

Gets a list of approve screen names

Returns:

Promise:

With {string[]} List of approved screen names

getBuildScreen

(
  • name
)
Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:294

Gets a specific build screen

Parameters:

  • name String

    Name of build screen

Returns:

Promise:

With {PNGImage}

getBuildScreenNames

() Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:281

Gets a list of build screen names

Returns:

Promise:

With {string[]} List of build screen names

getCurrentApprovedScreen

(
  • name
)
Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:215

Gets a specific currently approved screen

Parameters:

  • name String

    Name of approved screen

Returns:

Promise:

With {PNGImage} Approved screen

getCurrentApprovedScreenNames

() Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:203

Gets a list of currently approve screen names

Returns:

Promise:

With {string[]} List of approved screen names

getHighlightScreen

(
  • name
)
Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:334

Gets a specific highlight screen

Parameters:

  • name String

    Name of highlight screen

Returns:

Promise:

With {PNGImage}

getHighlightScreenNames

() Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:321

Gets a list of highlight screen names

Returns:

Promise:

With {string[]} List of highlight screen names

getPromise

() Promise

Inherited from StorageAdapter: lib/storageAdapter/storageAdapter.js:45

Gets the source-adapter promise

Returns:

Promise:

initialize

()

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:34

Initializes the source-adapter

setBuild

(
  • build
)

Inherited from StorageAdapter: lib/storageAdapter/storageAdapter.js:75

Sets the build information

Parameters:

setPromise

(
  • promise
)

Inherited from StorageAdapter: lib/storageAdapter/storageAdapter.js:55

Sets the promise

Parameters:

  • promise Promise

Properties

TYPE

String

Inherited from StorageAdapter but overwritten in lib/storageAdapter/fileStorageAdapter.js:363

Type of class