List

O módulo List é responsável por armazenar, obter e remover valores dentro de uma lista. Seus métodos podem ser acessados como mostrado no exemplo abaixo:

const lista = List.create["v1_0_0"]()

Métodos

create

Método responsável por criar uma nova lista.

const lista = List.create["v1_0_0"]()

Parâmetros obrigatórios

• Não há parâmetros obrigatórios.

Parâmetros opcionais

• Não há parâmetros opcionais.

Retorno

A constante ou variável criada, como a lista do exemplo mostrado anteriormente, retornará um valor do tipo List. O valor do tipo List possui os seguintes métodos e propriedades:

• lista.addItem(): Método responsável por adicionar um novo item na lista.
• lista.getItem(): Método responsável por obter um item da lista.
• lista.removeItem(): Método responsável por remover um item da lista.
• lista.clear(): Método responsável por remover todos os itens da lista.
• lista.size: Propriedade responsável por obter o tamanho da lista.
• lista.values: Propriedade responsável por obter os valores da lista.

addItem

Método responsável por adicionar um elemento a uma determinada lista.

const addList = await List.addList["v1_0_0"]({
    list: lista,
    value: 457
})

Parâmetros obrigatórios

• list: List - espera uma instância do tipo List obtida através do método create.
• value: Any - valor que será armazenado, podendo ser qualquer valor.

Parâmetros opcionais

• key: String - espera uma chave para apontar para o valor, caso o campo não seja preenchido, uma chave aleatória será gerada para o valor.

Retorno

A constante ou variável criada, como a addList do exemplo mostrado anteriormente, receberá um valor tipo Objeto que dará acesso as seguintes propriedades:

• addList.key: String - retorna a chave do valor armazenado.
• addList.value: Any - retorna o valor armazenado.

removeItem

Método responsável por remover um elemento de uma determinada lista.

List.removeItem["v1_0_0"]({
    list: lista,
    key: addList.key
})

Parâmetros obrigatórios

• list: List - espera uma instância do tipo List obtida através do método create.
• key: String - espera a chave do item que será removido da lista.

Retorno

Esta ação não possui retorno.

clear

Método responsável por remover todos os elementos de uma determinada lista.

List.clear["v1_0_0"]({
    list: lista
})

Parâmetros obrigatórios

• list: List - espera uma instância do tipo List obtida através do método create.

Retorno

Esta ação não possui retorno.

getValue

Método responsável por obter um valor da lista de acordo com a chave informada.

const getValue = actions.List.getValue["v1_0_0"]({
    list: lista,
    key: addList.key
})

Parâmetros obrigatórios

• list: List - espera uma instância do tipo List obtida através do método create.
• key: String - espera a chave do item que se deseja obter da lista.

Retorno

A constante ou variável criada, como a getValue do exemplo mostrado anteriormente, receberá um valor do tipo objeto que dará acesso as seguintes propriedades:

• getValue.key: String - retorna a chave do valor obtido pelo método.
• getValue.value: Any - retorna o valor obtido pelo método.

getAllValues

Método responsável por obter todos os valores armazenados em uma lista.

const allValues = await List.getAllValues["v1_0_0"]({
    list: lista
})

Parâmetros obrigatórios

• list: List - espera uma instância do tipo List obtida através do método create.

Retorno

A constante ou variável criada, como a allValues do exemplo mostrado anteriormente, receberá um valor do tipo objeto com a seguinte propriedade:

• allValues.values: Any - retorna todos os valores armazenados na lista, ou null caso a lista esteja vazia.