mirror of
https://github.com/wekan/wekan.git
synced 2025-12-20 09:20:12 +01:00
Fixed Non-ASCII attachment filename will crash when downloading.
Thanks to xet7 ! Fixes #2759
This commit is contained in:
parent
843ff8eaaa
commit
c2da477735
277 changed files with 30568 additions and 52 deletions
151
packages/wekan-cfs-power-queue/spinal-queue.spec.md
Normal file
151
packages/wekan-cfs-power-queue/spinal-queue.spec.md
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
#Spinal Queue Spec
|
||||
This specification declares the interface for the "spinal" queue in `PowerQueue`.
|
||||
We allready have two implementations the [MicroQueue](https://github.com/zcfs/Meteor-micro-queue) and [ReactiveList](https://github.com/zcfs/Meteor-reactive-list)
|
||||
|
||||
#SpinalQueue
|
||||
Provides a simple reactive list interface
|
||||
|
||||
#### <a name="SpinalQueue"></a>new SpinalQueue(lifo) <sub><i>Anywhere</i></sub> ####
|
||||
-
|
||||
|
||||
__Arguments__
|
||||
|
||||
* __lifo__ *{boolean}*
|
||||
Set the order of the queue default is `fifo`
|
||||
|
||||
-
|
||||
Example:
|
||||
```js
|
||||
var list = new SpinalQueue();
|
||||
list.insert(1, { text: 'Hello id: 1' });
|
||||
list.insert(2, { text: 'Hello id: 2' });
|
||||
list.insert(3, { text: 'Hello id: 3' });
|
||||
list.update(2, { text: 'Updated 2'});
|
||||
list.remove(1);
|
||||
|
||||
list.forEach(function(value, key) {
|
||||
console.log('GOT: ' + value.text);
|
||||
}, true); // Set noneReactive = true, default behaviour is reactive
|
||||
// Return from Template:
|
||||
Template.hello.list = function() {
|
||||
return list.fetch();
|
||||
};
|
||||
```
|
||||
|
||||
-
|
||||
|
||||
#### <a name="SpinalQueue.length"></a>*SpinalQueue*.length() <sub><i>Anywhere</i></sub> ####
|
||||
-
|
||||
*This method __length__ is defined in `SpinalQueue`*
|
||||
|
||||
__Returns__ *{number}* __(is reactive)__
|
||||
Length of the reactive list
|
||||
|
||||
-
|
||||
|
||||
#### <a name="SpinalQueue.reset"></a>*SpinalQueue*.reset() <sub><i>Anywhere</i></sub> ####
|
||||
-
|
||||
*This method __reset__ is defined in `SpinalQueue`*
|
||||
|
||||
-
|
||||
|
||||
#### <a name="SpinalQueue.update"></a>*SpinalQueue*.update(key, value) <sub><i>Anywhere</i></sub> ####
|
||||
-
|
||||
*This method __update__ is defined in `SpinalQueue`*
|
||||
|
||||
__Arguments__
|
||||
|
||||
* __key__ *{string|number}*
|
||||
Key to update
|
||||
* __value__ *{any}*
|
||||
Update with this value
|
||||
|
||||
> Note: Method is currently not used by `PowerQueue`
|
||||
|
||||
-
|
||||
|
||||
#### <a name="SpinalQueue.insert"></a>*SpinalQueue*.insert(key, value) <sub><i>Anywhere</i></sub> ####
|
||||
-
|
||||
*This method __insert__ is defined in `SpinalQueue`*
|
||||
|
||||
__Arguments__
|
||||
|
||||
* __key__ *{string|number}*
|
||||
Key to insert
|
||||
* __value__ *{any}*
|
||||
Insert item with this value
|
||||
|
||||
-
|
||||
|
||||
#### <a name="SpinalQueue.remove"></a>*SpinalQueue*.remove(key) <sub><i>Anywhere</i></sub> ####
|
||||
-
|
||||
*This method __remove__ is defined in `SpinalQueue`*
|
||||
|
||||
__Arguments__
|
||||
|
||||
* __key__ *{string|number}*
|
||||
Key to remove
|
||||
|
||||
-
|
||||
|
||||
#### <a name="SpinalQueue.getLastItem"></a>*SpinalQueue*.getLastItem() <sub><i>Anywhere</i></sub> ####
|
||||
-
|
||||
*This method __getLastItem__ is defined in `SpinalQueue`*
|
||||
|
||||
__Returns__ *{any}*
|
||||
Pops last item from the list - removes the item from the list
|
||||
|
||||
> Note: Method is currently not used by `PowerQueue`
|
||||
|
||||
-
|
||||
|
||||
#### <a name="SpinalQueue.getFirstItem"></a>*SpinalQueue*.getFirstItem() <sub><i>Anywhere</i></sub> ####
|
||||
-
|
||||
*This method __getFirstItem__ is defined in `SpinalQueue`*
|
||||
|
||||
__Returns__ *{any}*
|
||||
Pops first item from the list - removes the item from the list
|
||||
|
||||
|
||||
#### <a name="SpinalQueue.forEach"></a>*SpinalQueue*.forEach(f, [noneReactive], [reverse]) <sub><i>Anywhere</i></sub> ####
|
||||
-
|
||||
*This method __forEach__ is defined in `SpinalQueue`*
|
||||
|
||||
__Arguments__
|
||||
|
||||
* __f__ *{function}*
|
||||
Callback `funciton(value, key)`
|
||||
* __noneReactive__ *{boolean}* (Optional = false)
|
||||
Set true if want to disable reactivity
|
||||
|
||||
-
|
||||
|
||||
|
||||
#### <a name="SpinalQueue.forEachReverse"></a>*SpinalQueue*.forEachReverse(f, [noneReactive]) <sub><i>Anywhere</i></sub> ####
|
||||
-
|
||||
*This method __forEachReverse__ is defined in `SpinalQueue`*
|
||||
|
||||
__Arguments__
|
||||
|
||||
* __f__ *{function}*
|
||||
Callback `funciton(value, key)`
|
||||
* __noneReactive__ *{boolean}* (Optional = false)
|
||||
Set true if want to disable reactivity
|
||||
|
||||
-
|
||||
|
||||
#### <a name="SpinalQueue.fetch"></a>*SpinalQueue*.fetch([noneReactive]) <sub><i>Anywhere</i></sub> ####
|
||||
-
|
||||
*This method __fetch__ is defined in `SpinalQueue`*
|
||||
|
||||
__Arguments__
|
||||
|
||||
* __noneReactive__ *{boolean}* (Optional = false)
|
||||
Set true if want to disable reactivity
|
||||
|
||||
-
|
||||
|
||||
__Returns__ *{array}* __(is reactive)__
|
||||
List of items
|
||||
|
||||
-
|
||||
Loading…
Add table
Add a link
Reference in a new issue