Начало работы


Blank CLI


Blank Schema


Serverside JS API


HTTP API


Интеграция


Queue

Модуль queue предназначен для работы с сервером очередей Blank, представляющим сервис, двусвязных списков и очередей. В данный момент доступен только сервис двусвязных списков.

Подключение

let List = require("queue").List;
let list = new List("listName");

back()

Переводит курсор в конец списка.

Синтаксис

queue.back(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась. При успешном выполнении, результатом будет элемент списка.

drop()

Удаляет список на сервере.

Синтаксис

queue.drop(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась.

front()

Переводит курсор в начало списка.

Синтаксис

queue.front(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась. При успешном выполнении, результатом будет элемент списка.

getById()

Возвращает элемент списка с указанным идентификатором. Идентификатором элемента является свойство _id, в случае, если элемент представляет собой JavaScript Object. Не передвигает курсор.

Синтаксис

queue.getById(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась. При успешном выполнении, результатом будет элемент списка.

gotoPosition()

Переводит курсор на указанную позицию в списке.

Синтаксис

queue.gotoPosition(callback)

Параметры

callback

Функция, которая будет выполнена по завершению перевод (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась. При успешном выполнении, результатом будет элемент списка.

length()

Возвращает количество элементов списка.

Синтаксис

queue.length(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась.

next()

Переводит курсор на следующий элемент списка.

Синтаксис

queue.next(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась. При успешном выполнении, результатом будет элемент списка.

position()

Возвращает позицию текущего элемента списка.

Синтаксис

queue.position(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась.

prev()

Переводит курсор на предыдущий элемент списка.

Синтаксис

queue.prev(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась. При успешном выполнении, результатом будет элемент списка.

pushBack()

Добавляет элемент в конец списка.

Синтаксис

queue.pushBack(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась. При успешном выполнении, результатом будет позиция добавленного в список элемента.

pushFront()

Добавляет элемент в начало списка.

Синтаксис

queue.pushFront(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась. При успешном выполнении, результатом будет позиция добавленного в список элемента.

remove()

Удаляет текущий элемент из списка.

Синтаксис

queue.remove(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась.

update()

Изменяет текущий элемент из списка.

Синтаксис

queue.update(callback)

Параметры

callback

Функция, которая будет выполнена по завершению (опционально).

Возвращаемые значения

null в случае переданной функции callback или Promise, если функция не передавалась.