jake-stewart / sane.lua

javascript array interface in lua

warning

api likely to change

sane.lua

i don't like lua.

1. one-based indexing is terrible
2. lacks solid builtins

on the other hand, javascript has a beautiful Array api and uses 0-based indexing.

this library implements Array, String, and Object from javascript, and range from python to make lua usable.

Array

You can pass an Array to any lua function expecting a regular table and nothing will break.

To achieve interoperability, __index and __pairs have not been overloaded. This means that you should use array:at(0) instead of array[1] and for i, v in array instead of for i, v in pairs(array) for 0 based indexing.

you will also want to use array:splice(idx, 0, item) to insert item at idx.

usage

local Array = require("Array")
local array = Array({"a", "b", "c"})
print(array:at(0)) -- prints "a"

-- prints "0 a", "1 b", "2 c"
for i, v in array do
    print(i, v)
end

supported methods:

• at
• push
• pop
• shift
• unshift
• slice
• splice
• reverse
• sort
• forEach
• map
• filter
• indexOf
• lastIndexOf
• includes
• reduce
• reduceRight
• find
• findIndex
• concat
• join
• fill
• every
• some
• copyWithin
• unpack

String

You can pass a String to any lua function expecting a regular string and nothing will break.

usage

local String = require("String")

local string = String("hello world")

print(string:split(" "):at(0)) -- prints "hello"

supported methods:

• slice
• split
• trim
• trimEnd
• trimStart
• rep
• replace
• padEnd
• padStart
• match
• includes
• indexOf
• lastIndexOf
• toLowerCase
• toUpperCase
• startsWith
• endsWith
• substring
• at

the command match uses the table.match.

Object

usage

local Object = require("Object")

local object = {
    hello = "world"
}

print(Object.keys({hello = "world"}):at(0)) -- prints "hello"

supported methods:

• keys
• values
• entries
• fromEntries

local range = require("range")

-- prints 0 to 9
for i in range(10) do
    print(i)
end

also supports start, stop, step like python

local range = require("range")

-- prints from 5, 7, 9
-- it is `_, i` because `_` is the key (0, 1, 2) and `i` is the value (5, 7, 9)
for _, i in range(5, 10, 2) do
    print(i)
end

range returns an array so you can do all the cool array methods

local range = require("range")

range(10):map(print)