API Docs for: 0.9.0
Show:

KeyValueStorageAdapter Class

Extends StorageAdapter
Defined in: lib/storageAdapter/keyValueStorageAdapter.js:10

Key-Value storage adapter

Constructor

KeyValueStorageAdapter

(
  • options
)

Defined in lib/storageAdapter/keyValueStorageAdapter.js:10

Parameters:

Methods

_blobImage

(
  • image
)
Promise private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:208

Saves an image to a blob and returns a promise for it

Parameters:

  • image PNGImage

Returns:

Promise:

With {Buffer} Blob

_bucketKeyFilter

(
  • key
)
Boolean private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:278

Key filter for bucket keys

Parameters:

Returns:

Boolean:

_getApprovedScreenBucket

(
  • [id]
)
String private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:241

Gets the approved-screen bucket

Parameters:

Returns:

String:

_getBuildScreenBucket

(
  • [id]
)
String private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:265

Gets the build-screen bucket

Parameters:

Returns:

String:

_getCurrentApprovedScreenBucket

(
  • [id]
)
String private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:229

Gets the current approved-screen bucket

Parameters:

Returns:

String:

_getHighlightScreenBucket

(
  • [id]
)
String private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:253

Gets the highlight-screen bucket

Parameters:

Returns:

String:

_loadImage

(
  • blob
)
Promise private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:188

Loads an image blob and returns a promise for it

Parameters:

  • blob Buffer

Returns:

Promise:

With {PNGImage} Image

_prepareBucket

() Promise private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:60

Prepare a bucket

Returns:

Promise:

_prepareBuildBucket

() Promise private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:168

Prepare the build bucket

Returns:

Promise:

_prepareCompanyBucket

() Promise private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:95

Prepare the companies bucket

Returns:

Promise:

_prepareDepartmentBucket

() Promise private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:113

Prepare the departments bucket

Returns:

Promise:

_prepareJobBucket

() Promise private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:149

Prepare the jobs bucket

Returns:

Promise:

_prepareProjectBucket

() Promise private

Defined in lib/storageAdapter/keyValueStorageAdapter.js:131

Prepare the projects bucket

Returns:

Promise:

archiveApprovedScreen

(
  • name
  • image
)
Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/keyValueStorageAdapter.js:362

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/keyValueStorageAdapter.js:406

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/keyValueStorageAdapter.js:318

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/keyValueStorageAdapter.js:450

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/keyValueStorageAdapter.js:347

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/keyValueStorageAdapter.js:335

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/keyValueStorageAdapter.js:391

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/keyValueStorageAdapter.js:379

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/keyValueStorageAdapter.js:303

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/keyValueStorageAdapter.js:291

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/keyValueStorageAdapter.js:435

Gets a specific highlight screen

Parameters:

  • name String

    Name of build screen

Returns:

Promise:

With {PNGImage} Build screen

getHighlightScreenNames

() Promise

Inherited from StorageAdapter but overwritten in lib/storageAdapter/keyValueStorageAdapter.js:423

Gets a list of build highlight names

Returns:

Promise:

With {string[]} List of build 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/keyValueStorageAdapter.js:38

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/keyValueStorageAdapter.js:468

Type of class