Программный интерфейс

Показывать:
Определен в: src\wsql.js:11
Модуль: wsql
Родительский модуль: common

Интерфейс к localstorage, alasql и pouchdb

  • Обеспечивает взаимодействие с локальными и серверными данными
  • Обслуживает локальные параметры пользователя

Методы

drop_tables

(
  • callback
)
асинхронный

Определен в src\wsql.js:285

Удаляет таблицы WSQL

Например, для последующего пересоздания при изменении структуры данных

Параметры:

  • callback Function

fetch_type

(
  • prm
  • type
)

Определен в src\wsql.js:152

Приведение типов при операциях с localStorage

Параметры:

  • prm Object
  • type Object

Возвращает:

:

get_user_param

(
  • prm_name
  • [type]
)

Определен в src\wsql.js:73

Возвращает значение сохраненного параметра из localStorage

Параметр извлекается с приведением типа

Параметры:

  • prm_name String
    • имя параметра
  • [type] String optional
    • имя типа параметра. Если указано, выполняем приведение типов

Возвращает:

:
  • значение параметра

init_params

() Promise асинхронный

Определен в src\wsql.js:188

Создаёт и заполняет умолчаниями таблицу параметров

Возвращает:

Promise:

promise

(
  • sql
  • params
)
Promise асинхронный

Определен в src\wsql.js:92

Выполняет sql запрос к локальной базе данных

Параметры:

  • sql Object
  • params Object

Возвращает:

Promise:

restore_options

(
  • prefix
  • options
)

Определен в src\wsql.js:129

Восстанавливает сохраненные параметры в объект options

Параметры:

  • prefix String
    • имя области
  • options Object
    • объект, в который будут записаны параметры

save_options

(
  • prefix
  • options
)
Promise асинхронный

Определен в src\wsql.js:115

Сохраняет настройки формы или иные параметры объекта options

Параметры:

  • prefix String
    • имя области
  • options Object
    • сохраняемые параметры

Возвращает:

Promise:

set_user_param

(
  • prm_name
  • prm_value
)
асинхронный

Определен в src\wsql.js:50

Устанавливает параметр в user_params и localStorage

Параметры:

  • prm_name String
    • имя параметра
  • prm_value String | Number | Object | Boolean
    • значение

Свойства

aladb

alasql.Database

Определен в src\wsql.js:326

Указатель на aladb

alasql

Function

Определен в src\wsql.js:179

Указатель на alasql

js_time_diff

Number

Определен в src\wsql.js:29

Поправка времени javascript

pouch

Pouch

Определен в src\wsql.js:265

Указатель на локальные и сетевые базы PouchDB

time_diff

Number

Определен в src\wsql.js:38

Поправка времени javascript с учетом пользовательского сдвига из константы time_diff