# List

Wrap [Redis List](https://redis.io/commands#list)

_Implements most used Redis commands, rest commands will implement during time or upon request_

---

**Example**

```javascript
let redisList = new RedisList('mykey');

await redisList.push('str1');
await redisList.push({a: 5, b: 6});
await redisList.push('str2');
await redisList.push('str3');
const index5 = await redisList.push('str4');
const index6 = await redisList.unshift('str5');

// Will print `5`
console.log(index5);

// Will print `6`
console.log(index6);

let data = await redisList.getAt(1);

await redisList.updateAt(1, 'rrr');

// Will print 'rrr'
let data = await redisList.getAt(1);

// Will print {a: 5, b: 6}
console.log(data); 

data = await redisList.pop();

// Will print 'str4'
console.log(data); 

data = await redisList.shift();

// Will print 'str5'
console.log(data);

data = await redisList.length();

// Will print 4
console.log(data); 
```

---

**Docs**

_Inherit more methods from [Redis Base](redisBase.md)_

> async push(mixed data):boolean
    
Insert an element into the end of the list

<sub>Wrap [RPUSH](https://redis.io/commands/rpush)</sup>

> async unshift(mixed data):boolean
    
Insert an element into the beginning of the list

<sub>Wrap [LPUSH](https://redis.io/commands/lpush)</sub>

> async pop(object options):mixed

Pop the last element of the list

<sub>Wrap [RPOP](https://redis.io/commands/rpop)</sub>

> async shift():mixed

Pop the first element of the list

<sub>Wrap [LPOP](https://redis.io/commands/lpop)</sub>

> async getAt(int index):mixed
    
Returns the element at `index` in the list

<sub>Wrap [LINDEX](https://redis.io/commands/lindex)</sub>

> async updateAt(int index, object data):mixed

Update the element at `index` in the list

<sub>Wrap [LSET](https://redis.io/commands/lset/)</sub>

> async getAll(int start = 0, int length = -1):array
    
Returns `length` number of elements from the `start` point of the list, 
calling the function with the default arguments will return all elements in the list

<sub>Wrap [LRANGE](https://redis.io/commands/lrange)</sub>

> async length():int
    
Get the length of the list

<sub>Wrap [LLEN](https://redis.io/commands/llen)</sub>

> async remove(what, count = 0):int
    
Remove elements from the list by name

<sub>Wrap [LREM](https://redis.io/commands/lrem)</sub>

> async exists():boolean

Will return boolean answer if the object exists

<sub>Wrap [GET](https://redis.io/commands/exists)</sub>

> async getLast():boolean

Will return the last item form the list (that pushed recently)

<sub>A combination of `this.getLength` and then `this.getAt(length - 1)`</sub>