filtergc - Real Function Reference

filtergc(filterType: string, options: table, returnOne?: boolean): table | function | nil

Arguments

string

required

GC object type to search. The value is lowercased and must be “table” or “function”.

table

required

Filter table. Function searches read Name, Hash, StartLine, IgnoreExecutor, IgnoreSyn, Environment, Constants, and Upvalues. Table searches read Metatable, Keys, Values, and KeyValuePairs.

boolean

Optional optional boolean handling flag. When true, returns the first matching object or nil instead of an array table.

Returns

table | function | nil

When returnOne is false or omitted, an array table of matches. When returnOne is true, the first matching table/function object or nil.

Example

Find GC tables by key filters without relying on result order.

local marker = {
    RealDocsMarker = true,
}

local matches = filtergc("table", {
    Keys = { "RealDocsMarker" },
})

for _, value in ipairs(matches) do
    if value == marker then
        print("found marker")
        break
    end
end

local first = filtergc("table", {
    Keys = { "RealDocsMarker" },
}, true)

print(first ~= nil)

​Arguments

​Returns

​Example

Arguments

Returns

Example