API Docs for:
Show:

UpdateConfig Class

Defined in: /home/salva/workspace/offliner/src/offliner.js:890
Module: off

Update consists into determine if there is a new version and then evolve the current cache to be up to date. To register an update algorithm you provide a UpdateImplementation instance by using use.

Item Index

Methods

Properties

Methods

check

()

Defined in /home/salva/workspace/offliner/src/offliner.js:950

Triggers the check algorithm of the registered update implementation.

evolve

()

Defined in /home/salva/workspace/offliner/src/offliner.js:971

Performs the evolve process of the registered update implementation.

isNewVersion

()

Defined in /home/salva/workspace/offliner/src/offliner.js:960

Calls the isNewVersion check of the registered update implementation.

option

(
  • optname
  • [value]
)
Any chainable

Defined in /home/salva/workspace/offliner/src/offliner.js:903

Gets or set an option.

Parameters:

  • optname String

    The name of the option to be set or get.

  • [value] Any optional

    If provided, the value to be set for the passed option.

Returns:

Any:

The value of the option when getting.

use

(
  • impl
)
chainable

Defined in /home/salva/workspace/offliner/src/offliner.js:922

Register the update implementation.

Parameters:

Properties

flags

UpdateFlags

Defined in /home/salva/workspace/offliner/src/offliner.js:935

Flags set at the beginning of the update process. They include: