Shared

lib.array

Uma tabela usada como protótipo para a classe Array. Funções podem ser usadas como métodos de classe ou funções padrão.

lib.array:new

Constrói uma instância de Array contendo os elementos fornecidos.

• ...: any

lib.array:new(...)

Returns:

• arr: Array

lib.array.from

Cria um novo array a partir de um valor iterável.

• iter: function | table | string
  • Funções iteradoras como string.gmatch podem ser usadas para construir arrays.

lib.array.from(iter)

Returns:

• arr: Array

lib.array.at

Retorna o elemento no índice fornecido, com números negativos contando de trás para frente a partir do fim do array.

• index: integer

lib.array.at(index)

Returns:

• element: unknown

lib.array.merge

Combina os elementos de dois ou mais arrays em um novo array.

• ...: Array

lib.array.merge(...)

Returns:

• Array

lib.array.every

Testa se todos os elementos em um array passam na função de teste fornecida.

• arr: Array
• testFn: function(element: unknown): boolean

lib.array.every(arr, testFn)

Returns:

• success: boolean

lib.array.fill

Define todos os elementos dentro de um intervalo para o valor fornecido e retorna o array modificado.

• arr: Array
• value: any
• start?: integer
• endIndex?: integer

lib.array.fill(arr, value, start, endIndex)

Returns:

• arr: Array

lib.array.filter

Cria um novo array contendo os elementos de um array que passam na função de teste fornecida.

• arr: Array
• testFn: function(element: unknown): boolean

lib.array.filter(arr, testFn)

Returns:

• newArr: Array

lib.array.find

Retorna o primeiro elemento de um array que passa na função de teste fornecida.

• arr: Array
• testFn: function(element: unknown): boolean
• reverse?: boolean
  • Itera sobre o array em ordem reversa.

lib.array.find(arr, testFn, reverse)

Returns:

• element: unknown

lib.array.findIndex

Retorna o índice do primeiro elemento de um array que passa na função de teste fornecida.

• arr: Array
• testFn: function(element: unknown): boolean
• reverse?: boolean
  • Itera sobre o array em ordem reversa.

lib.array.findIndex(arr, testFn, reverse)

Returns:

• index: integer

lib.array.indexOf

Retorna o índice do primeiro elemento de um array que corresponde ao valor fornecido.

• arr: Array
• value: any
• reverse?: boolean
  • Itera sobre o array em ordem reversa.

lib.array.indexOf(arr, value, reverse)

Returns:

• index: integer

lib.array.forEach

Executa a função fornecida para cada elemento em um array.

• arr: Array
• cb: function(element: unknown)

lib.array.forEach(arr, cb, reverse)

Returns:

• index: integer

lib.array.join

Concatena todos os elementos de um array em uma string, separados por vírgulas ou pelo separador especificado.

• arr: Array
• seperator?: string

lib.array.join(arr, seperator)

Returns:

• str: string

lib.array.map

Cria um novo array contendo os resultados da chamada da função fornecida em cada elemento de um array.

• fn: function(element: unknown, index: integer, arr: Array): unknown

lib.array.map(arr, fn)

Returns:

• newArr: Array

lib.array.pop

Remove o último elemento de um array e retorna o valor.

• arr: Array

lib.array.pop(arr)

Returns:

• element: unknown

lib.array.push

Adiciona os elementos fornecidos ao fim de um array e retorna o novo comprimento do array.

• arr: Array
• ...: any

lib.array.push(arr, ...)

Returns:

• length: integer

lib.array.shift

Remove o primeiro elemento de um array e retorna o valor.

• arr: Array

lib.array.shift(arr)

Returns:

• element: unknown

lib.array.slice

Cria uma cópia rasa de uma porção de um array como um novo array.

• arr: Array
• start?: integer
• finish?: integer

lib.array.slice(arr, start, finish)

Returns:

• newArr: Array

lib.array.toReversed

Cria um novo array com a ordem de seus elementos invertida a partir do array fornecido.

• arr: Array

lib.array.toReversed(arr)

Returns:

• newArr: Array

lib.array.unshift

Insere novos elementos no início de um array e retorna o novo comprimento do array.

• arr: Array
• ...: any

lib.array.unshift(arr, ...)

Returns:

• length: integer

lib.array.reduce

A função "reducer" é aplicada a cada elemento em um array, com o resultado anterior servindo como acumulador.
Se um valor inicial for fornecido, ele é usado como acumulador para o primeiro índice; caso contrário, a iteração começa no segundo índice, com o primeiro índice como acumulador.

• arr: Array
• reducer: function(accumulator: unknown, element: unknown, index?: integer)
• initialValue?: any

lib.array.reduce(arr, reducer)

Returns:

• accumulator: unknown

lib.array.reverse

Inverte a ordem dos elementos dentro de um array.

• arr: Array

lib.array.reverse(arr)

Returns:

• arr: Array

lib.isArray

Determina se a tabela fornecida é uma instância de Array ou uma tabela do tipo array.

• tbl: table

lib.array.isArray(tbl)

Returns:

• isArray: boolean