Skip to content

Commit

Permalink
refactor(array): typing issue
Browse files Browse the repository at this point in the history
Assigning a variable to a class seems to break private/protected
access with LLS. Revert this in the future if fixed.
  • Loading branch information
thelindat committed Jul 26, 2024
1 parent 2b9f49f commit 026d3de
Showing 1 changed file with 19 additions and 21 deletions.
40 changes: 19 additions & 21 deletions imports/array/shared.lua
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---@class Array : OxClass
local Array = lib.class('Array')
lib.array = lib.class('Array')

---@alias ArrayLike<T> Array | { [number]: T }

---@private
function Array:constructor(...)
function lib.array:constructor(...)
local arr = { ... }

for i = 1, #arr do
Expand All @@ -13,15 +13,15 @@ function Array:constructor(...)
end

---@private
function Array:__newindex(index, value)
function lib.array:__newindex(index, value)
if type(index) ~= 'number' then error(("Cannot insert non-number index '%s' into an array."):format(index)) end

rawset(self, index, value)
end

---Create a new array containing the elements from two arrays.
---@param arr ArrayLike
function Array:merge(arr)
function lib.array:merge(arr)
local newArr = table.clone(self)
local length = #self

Expand All @@ -30,12 +30,12 @@ function Array:merge(arr)
newArr[length] = arr[i]
end

return Array:new(table.unpack(newArr))
return lib.array:new(table.unpack(newArr))
end

---Tests if all elements in an array succeed in passing the provided test function.
---@param testFn fun(element: unknown): boolean
function Array:every(testFn)
function lib.array:every(testFn)
for i = 1, #self do
if not testFn(self[i]) then
return false
Expand All @@ -47,7 +47,7 @@ end

---Creates a new array containing the elements from an array thtat pass the test of the provided function.
---@param testFn fun(element: unknown): boolean
function Array:filter(testFn)
function lib.array:filter(testFn)
local newArr = {}
local length = 0

Expand All @@ -60,13 +60,13 @@ function Array:filter(testFn)
end
end

return Array:new(table.unpack(newArr))
return lib.array:new(table.unpack(newArr))
end

---Returns the first or last element of an array that passes the provided test function.
---@param testFn fun(element: unknown): boolean
---@param last? boolean
function Array:find(testFn, last)
function lib.array:find(testFn, last)
local a = last and #self or 1
local b = last and 1 or #self
local c = last and -1 or 1
Expand All @@ -83,7 +83,7 @@ end
---Returns the first or last index of the first element of an array that passes the provided test function.
---@param testFn fun(element: unknown): boolean
---@param last? boolean
function Array:findIndex(testFn, last)
function lib.array:findIndex(testFn, last)
local a = last and #self or 1
local b = last and 1 or #self
local c = last and -1 or 1
Expand All @@ -100,7 +100,7 @@ end
---Returns the first or last index of the first element of an array that matches the provided value.
---@param value unknown
---@param last? boolean
function Array:indexOf(value, last)
function lib.array:indexOf(value, last)
local a = last and #self or 1
local b = last and 1 or #self
local c = last and -1 or 1
Expand All @@ -116,26 +116,26 @@ end

---Executes the provided function for each element in an array.
---@param cb fun(element: unknown)
function Array:forEach(cb)
function lib.array:forEach(cb)
for i = 1, #self do
cb(self[i])
end
end

---Concatenates all array elements into a string, seperated by commas or the specified seperator.
---@param seperator? string
function Array:join(seperator)
function lib.array:join(seperator)
return table.concat(self, seperator or ',')
end

---Removes the last element from an array and returns the removed element.
function Array:pop()
function lib.array:pop()
return table.remove(self)
end

---Adds the given elements to the end of an array and returns the new array length.
---@param ... any
function Array:push(...)
function lib.array:push(...)
local elements = { ... }
local length = #self

Expand All @@ -148,7 +148,7 @@ function Array:push(...)
end

---Removes the first element from an array and returns the removed element.
function Array:shift()
function lib.array:shift()
return table.remove(self, 1)
end

Expand All @@ -158,7 +158,7 @@ end
---@param reducer fun(accumulator: T, currentValue: T, index?: number): T
---@param initialValue? T
---@return T
function Array:reduce(reducer, initialValue)
function lib.array:reduce(reducer, initialValue)
local initialIndex = initialValue and 1 or 2
local accumulator = initialValue or self[1]

Expand All @@ -172,18 +172,16 @@ end
---Returns true if the given table is an instance of array or an array-like table.
---@param tbl ArrayLike
---@return boolean
function Array.isArray(tbl)
function lib.array.isArray(tbl)
if not type(tbl) == 'table' then return false end

local tableType = table.type(tbl)

if tableType == 'array' or tableType == 'empty' or Array.instanceOf(tbl, Array) then
if tableType == 'array' or tableType == 'empty' or lib.array.instanceOf(tbl, lib.array) then
return true
end

return false
end

lib.array = Array

return lib.array

0 comments on commit 026d3de

Please sign in to comment.