Skip to main content
Version: v0.21.0

Array

a = [1, 2, 3, 4, 5]
puts(a[2])
puts(a[-2])
puts(a[:2])
puts(a[:-2])
puts(a[2:])
puts(a[-2:])
puts(a[1:-2])

// should output
[1, 2]
[1, 2, 3]
[3, 4, 5]
[4, 5]
[2, 3]
[1, 2, 8, 9, 5]

Literal Specific Methods

first()

Returns STRING|ARRAY|HASH|BOOLEAN|INTEGER|NIL|FUNCTION|FILE

Returns the first element of the array. Shorthand for array[0]

["a", "b", 1, 2].first()
Output
"a"

include?(STRING|ARRAY|HASH|BOOLEAN|INTEGER|NIL|FILE)

Returns BOOLEAN

Returns true or false wether the array contains the given element

[1,2,3].include?(4)
[1,2,3].include?(3)
Output
false
true

index(STRING|ARRAY|HASH|BOOLEAN|INTEGER|NIL|FILE)

Returns INTEGER

Returns the index of the given element in the array if found. Otherwise return -1.

["a", "b", 1, 2].index(1)
Output
2

last()

Returns STRING|ARRAY|HASH|BOOLEAN|INTEGER|NIL|FUNCTION|FILE

Returns the last element of the array.

["a", "b", 1, 2].last()
Output
2

reverse()

Returns ARRAY

Reverses the elements of the array

["a", "b", 1, 2].reverse()
Output
[2, 1, "b", "a"]

size()

Returns INTEGER

Returns the amount of elements in the array.

["a", "b", 1, 2].size()
Output
4

slices(INTEGER)

Returns ARRAY

Returns the elements of the array in slices with the size of the given integer

[1,2,3,4,5,6,7,8].slices(3)
Output
[[1, 2, 3], [4, 5, 6], [7, 8]]

sort()

Returns ARRAY

Sorts the array if it contains only one type of STRING, INTEGER or FLOAT

[3.4, 3.1, 2.0].sort()
Output
[2.0, 3.1, 3.4]

uniq()

Returns ARRAY|ERROR

Returns a copy of the array with deduplicated elements. Raises an error if a element is not hashable.

["a", 1, 1, 2].uniq()
Output
[1, 2, "a"]

yeet()

Returns STRING|ARRAY|HASH|BOOLEAN|INTEGER|NIL|FUNCTION|FILE

Removes the last element of the array and returns it.

a = [1,2,3]
a.yeet()
a
Output
[1, 2, 3]
3
[1, 2]

yoink(STRING|ARRAY|HASH|BOOLEAN|INTEGER|NIL|FUNCTION|FILE)

Returns NIL

Adds the given object as last element to the array.

a = [1,2,3]
a.yoink("a")
a
Output
[1, 2, 3]
nil
[1, 2, 3, "a"]

Generic Literal Methods

methods()

Returns ARRAY

Returns an array of all supported methods names.

"test".methods()
Output
["upcase", "find", "format", "reverse", "split", "replace", "strip!", "count", "reverse!", "lines", "downcase!", "upcase!", "size", "plz_i", "strip", "downcase"]

to_json()

Returns STRING|ERROR

Returns the object as json notation.

a = {"test": 1234}
a.to_json()
Output
{"test": 1234}
"{\"test\":1234}"

type()

Returns STRING

Returns the type of the object.

"test".type()
Output
"STRING"

wat()

Returns STRING

Returns the supported methods with usage information.

true.wat()
Output
"BOOLEAN supports the following methods:
plz_s()"