Options
All
  • Public
  • Public/Protected
  • All
Menu

Use this to persist non-preference data for your plugin

This object is an instance of simonlast/node-persist

note:

The interface listed here should be up to date, but the github repository is the final implementation.

Example

'use strict';

module.exports = (pluginContext) => {
    const localStorage = pluginContext.localStorage;
    const logger       = pluginContext.logger;

    function startup() { ... }

    function search(query, res) { ... }

    function execute(id, payload, extra) {
        const last = localStorage.getItemSync('last_execute_time');
        const now  = DateTime.now();

        logger.log('Last execution time: %d, updating to %d', last, now);

        localStorage.setItemSync('last_execute_time', now);

        // ...
    }

    return { startup, search, execute};
};

Methods

  • clear(callback?: function): Promise<any>
  • Parameters

    callback:  function Optional 
      • (err: any): any
      • Parameters

        err:  any

        Returns any

    Returns Promise<any>

  • clearSync(): void
  • forEach(callback: function): void
  • Parameters

    callback:  function
      • (key: string, value: any): void
      • Parameters

        key:  string value:  any
  • getItem(key: string, callback?: function): Promise<any>
  • Parameters

    key:  string callback:  function Optional 
      • (err: any, value: any): any
      • Parameters

        err:  any value:  any

        Returns any

    Returns Promise<any>

  • getItemSync(key: string): any
  • Parameters

    key:  string

    Returns any

  • init(options?: InitOptions, callback?: Function): Promise<any>
  • Parameters

    options:  InitOptions Optional  callback:  Function Optional 

    Returns Promise<any>

  • initSync(options?: InitOptions): void
  • Parameters

    options:  InitOptions Optional 
  • keys(): Array<string>
  • Returns Array<string>

  • length(): number
  • Returns number

  • persist(callback?: function): Promise<any>
  • Parameters

    callback:  function Optional 
      • (err: any): any
      • Parameters

        err:  any

        Returns any

    Returns Promise<any>

  • persistKey(key: string, callback?: function): Promise<any>
  • Parameters

    key:  string callback:  function Optional 
      • (err: any): any
      • Parameters

        err:  any

        Returns any

    Returns Promise<any>

  • persistKeySync(key: string): void
  • Parameters

    key:  string
  • persistSync(): void
  • removeItem(key: string, callback?: function): Promise<any>
  • Parameters

    key:  string callback:  function Optional 
      • (err: any): any
      • Parameters

        err:  any

        Returns any

    Returns Promise<any>

  • removeItemSync(key: string): void
  • Parameters

    key:  string
  • setItem(key: string, value: any, callback?: function): Promise<any>
  • Parameters

    key:  string value:  any callback:  function Optional 
      • (err: any): any
      • Parameters

        err:  any

        Returns any

    Returns Promise<any>

  • setItemSync(key: string, value: any): void
  • Parameters

    key:  string value:  any
  • values(): Array<any>
  • Returns Array<any>

  • valuesWithKeyMatch(match: string): Array<any>
  • Parameters

    match:  string

    Returns Array<any>

Generated using TypeDoc