Janet 1.5.0-719f7ba Documentation
(Other Versions: 1.5.0 1.4.0 1.3.1)

Core API

Index

% %= * *= + ++ += - -- -= -> ->> -?> -?>> / /= < <= = == > >= abstract? all all-bindings all-dynamics and apply array array/concat array/ensure array/insert array/new array/peek array/pop array/push array/remove array/slice array? as-> as?-> asm bad-compile bad-parse band blshift bnot boolean? bor brshift brushift buffer buffer/bit buffer/bit-clear buffer/bit-set buffer/bit-toggle buffer/blit buffer/clear buffer/format buffer/new buffer/new-filled buffer/popn buffer/push-byte buffer/push-string buffer/push-word buffer/slice buffer? bxor bytes? case cfunction? cli-main comment comp compile complement cond coro count debug debug/arg-stack debug/break debug/fbreak debug/lineage debug/stack debug/stacktrace debug/unbreak debug/unfbreak dec deep-not= deep= def- default defglobal defmacro defmacro- defn defn- describe dictionary? disasm distinct doc doc* doc-format dofile drop drop-until drop-while dyn each empty? env-lookup eprin eprint eprintf error eval eval-string even? every? extreme false? fiber/current fiber/getenv fiber/maxstack fiber/new fiber/setenv fiber/setmaxstack fiber/status fiber? file/close file/fdopen file/fileno file/flush file/open file/popen file/read file/seek file/write filter find find-index first flatten flatten-into for freeze frequencies function? gccollect gcinterval gcsetinterval generate gensym get get-in getline hash idempotent? identity if-let if-not import import* in inc indexed? int/s64 int/u64 int? interleave interpose invert janet/build janet/config-bits janet/version juxt juxt* keep keys keyword keyword? kvs last length let load-image loop macex macex1 make-env make-image map mapcat marshal match math/abs math/acos math/asin math/atan math/atan2 math/ceil math/cos math/cosh math/e math/exp math/floor math/inf math/log math/log10 math/pi math/pow math/random math/rng math/rng-int math/rng-uniform math/seedrandom math/sin math/sinh math/sqrt math/tan math/tanh max max-order mean merge merge-into min min-order module/cache module/expand-path module/find module/loaders module/loading module/paths nat? native neg? next nil? not not= not== number? odd? one? or order< order<= order> order>= os/arch os/cd os/clock os/cwd os/date os/dir os/execute os/exit os/getenv os/link os/mkdir os/rename os/rm os/rmdir os/setenv os/shell os/sleep os/stat os/time os/touch os/which pairs parser/byte parser/clone parser/consume parser/eof parser/error parser/flush parser/has-more parser/insert parser/new parser/produce parser/state parser/status parser/where partial partition peg/compile peg/match pos? postwalk pp prewalk prin print printf product propagate put put-in quit range reduce repl require resume reverse run-context scan-number seq setdyn short-fn slice slurp some sort sorted spit stderr stdin stdout string string/ascii-lower string/ascii-upper string/bytes string/check-set string/find string/find-all string/format string/from-bytes string/has-prefix? string/has-suffix? string/join string/repeat string/replace string/replace-all string/reverse string/slice string/split string/trim string/triml string/trimr string? struct struct? sum symbol symbol? table table/clone table/getproto table/new table/rawget table/setproto table/to-struct table? take take-until take-while tarray/buffer tarray/copy-bytes tarray/length tarray/new tarray/properties tarray/slice tarray/swap-bytes trace true? try tuple tuple/brackets tuple/setmap tuple/slice tuple/sourcemap tuple/type tuple? type unless unmarshal untrace update update-in use values varfn varglobal walk when when-let with with-dyns with-syms with-vars yield zero? zipcoll


% cfunction
(% dividend divisor)

Returns the remainder of dividend / divisor.

%= macro
(%= x n)

Shorthand for (set x (% x n)).

* function
(* & xs)

Returns the product of all elements in xs. If xs is empty, returns 1.

*= macro
(*= x n)

Shorthand for (set x (* x n)).

+ function
(+ & xs)

Returns the sum of all xs. xs must be integers or real numbers only. If xs is empty, return 0.

++ macro
(++ x)

Increments the var x by 1.

+= macro
(+= x n)

Increments the var x by n.

- function
(- & xs)

Returns the difference of xs. If xs is empty, returns 0. If xs has one element, returns the negative value of that element. Otherwise, returns the first element in xs minus the sum of the rest of the elements.

-- macro
(-- x)

Decrements the var x by 1.

-= macro
(-= x n)

Decrements the var x by n.

-> macro
(-> x & forms)

Threading macro. Inserts x as the second value in the first form in forms, and inserts the modified first form into the second form in the same manner, and so on. Useful for expressing pipelines of data.

->> macro
(->> x & forms)

Threading macro. Inserts x as the last value in the first form in forms, and inserts the modified first form into the second form in the same manner, and so on. Useful for expressing pipelines of data.

-?> macro
(-?> x & forms)

Short circuit threading macro. Inserts x as the last value in the first form in forms, and inserts the modified first form into the second form in the same manner, and so on. The pipeline will return nil if an intermediate value is nil. Useful for expressing pipelines of data.

-?>> macro
(-?>> x & forms)

Threading macro. Inserts x as the last value in the first form in forms, and inserts the modified first form into the second form in the same manner, and so on. The pipeline will return nil if an intermediate value is nil. Useful for expressing pipelines of data.

/ function
(/ & xs)

Returns the quotient of xs. If xs is empty, returns 1. If xs has one value x, returns the reciprocal of x. Otherwise return the first value of xs repeatedly divided by the remaining values. Division by two integers uses truncating division.

/= macro
(/= x n)

Shorthand for (set x (/ x n)).

< function
(< & xs)

Check if xs is in numerically ascending order. Returns a boolean.

<= function
(<= & xs)

Check if xs is in numerically non-descending order. Returns a boolean.

= function
(= & xs)

Returns true if all values in xs are the same, false otherwise.

== function
(== & xs)

Check if all values in xs are numerically equal (4.0 == 4). Returns a boolean.

> function
(> & xs)

Check if xs is in numerically descending order. Returns a boolean.

>= function
(>= & xs)

Check if xs is in numerically non-ascending order. Returns a boolean.

abstract? cfunction
(abstract? x)

Check if x is an abstract type.

all function
(all pred xs)

Returns true if all xs are truthy, otherwise the first false or nil value.

all-bindings function
(all-bindings &opt env)

Get all symbols available in an enviroment. Defaults to the current fiber's environment.

all-dynamics function
(all-dynamics &opt env)

Get all dynamic bindings in an environment. Defaults to the current fiber's environment.

and macro
(and & forms)

Evaluates to the last argument if all preceding elements are true, otherwise evaluates to false.

apply function
(apply f & args)

Applies a function to a variable number of arguments. Each element in args is used as an argument to f, except the last element in args, which is expected to be an array-like. Each element in this last argument is then also pushed as an argument to f. For example:

	(apply + 1000 (range 10))

sums the first 10 integers and 1000.

array cfunction
(array & items)

Create a new array that contains items. Returns the new array.

array/concat cfunction
(array/concat arr & parts)

Concatenates a variadic number of arrays (and tuples) into the first argument which must an array. If any of the parts are arrays or tuples, their elements will be inserted into the array. Otherwise, each part in parts will be appended to arr in order. Return the modified array arr.

array/ensure cfunction
(array/ensure arr capacity)

Ensures that the memory backing the array is large enough for capacity items. Capacity must be an integer. If the backing capacity is already enough, then this function does nothing. Otherwise, the backing memory will be reallocated so that there is enough space.

array/insert cfunction
(array/insert arr at & xs)

Insert all of xs into array arr at index at. at should be an integer 0 and the length of the array. A negative value for at will index from the end of the array, such that inserting at -1 appends to the array. Returns the array.

array/new cfunction
(array/new capacity)

Creates a new empty array with a pre-allocated capacity. The same as (array) but can be more efficient if the maximum size of an array is known.

array/peek cfunction
(array/peek arr)

Returns the last element of the array. Does not modify the array.

array/pop cfunction
(array/pop arr)

Remove the last element of the array and return it. If the array is empty, will return nil. Modifies the input array.

array/push cfunction
(array/push arr x)

Insert an element in the end of an array. Modifies the input array and returns it.

array/remove cfunction
(array/remove arr at &opt n)

Remove up to n elements starting at index at in array arr. at can index from the end of the array with a negative index, and n must be a non-negative integer. By default, n is 1. Returns the array.

array/slice cfunction
(array/slice arrtup &opt start end)

Takes a slice of array or tuple from start to end. The range is half open, [start, end). Indexes can also be negative, indicating indexing from the end of the end of the array. By default, start is 0 and end is the length of the array. Returns a new array.

array? function
(array? x)

Check if x is an array.

as-> macro
(as-> x as & forms)

Thread forms together, replacing as in forms with the value of the previous form. The first for is the value x. Returns the last value.

as?-> macro
(as?-> x as & forms)

Thread forms together, replacing as in forms with the value of the previous form. The first for is the value x. If any intermediate values are falsey, return nil; otherwise, returns the last value.

asm cfunction
(asm assembly)

Returns a new function that is the compiled result of the assembly.
The syntax for the assembly can be found on the janet wiki. Will throw an
error on invalid assembly.

bad-compile function
(bad-compile msg macrof where)

Default handler for a compile error.

bad-parse function
(bad-parse p where)

Default handler for a parse error.

band function
(band & xs)

Returns the bit-wise and of all values in xs. Each x in xs must be an integer.

blshift function
(blshift x & shifts)

Returns the value of x bit shifted left by the sum of all values in shifts. x and each element in shift must be an integer.

bnot function
(bnot x)

Returns the bit-wise inverse of integer x.

boolean? function
(boolean? x)

Check if x is a boolean.

bor function
(bor & xs)

Returns the bit-wise or of all values in xs. Each x in xs must be an integer.

brshift function
(brshift x & shifts)

Returns the value of x bit shifted right by the sum of all values in shifts. x and each element in shift must be an integer.

brushift function
(brushift x & shifts)

Returns the value of x bit shifted right by the sum of all values in shifts. x and each element in shift must be an integer. The sign of x is not preserved, so for positive shifts the return value will always be positive.

buffer cfunction
(buffer & xs)

Creates a new buffer by concatenating values together. Values are converted to bytes via describe if they are not byte sequences. Returns the new buffer.

buffer/bit cfunction
(buffer/bit buffer index)

Gets the bit at the given bit-index. Returns true if the bit is set, false if not.

buffer/bit-clear cfunction
(buffer/bit-clear buffer index)

Clears the bit at the given bit-index. Returns the buffer.

buffer/bit-set cfunction
(buffer/bit-set buffer index)

Sets the bit at the given bit-index. Returns the buffer.

buffer/bit-toggle cfunction
(buffer/bit-toggle buffer index)

Toggles the bit at the given bit index in buffer. Returns the buffer.

buffer/blit cfunction
(buffer/blit dest src & opt dest-start src-start src-end)

Insert the contents of src into dest. Can optionally take indices that indicate which part of src to copy into which part of dest. Indices can be negative to index from the end of src or dest. Returns dest.

buffer/clear cfunction
(buffer/clear buffer)

Sets the size of a buffer to 0 and empties it. The buffer retains its memory so it can be efficiently refilled. Returns the modified buffer.

buffer/format cfunction
(buffer/format buffer format & args)

Snprintf like functionality for printing values into a buffer. Returns the modified buffer.

buffer/new cfunction
(buffer/new capacity)

Creates a new, empty buffer with enough memory for capacity bytes. Returns a new buffer.

buffer/new-filled cfunction
(buffer/new-filled count &opt byte)

Creates a new buffer of length count filled with byte. By default, byte is 0. Returns the new buffer.

buffer/popn cfunction
(buffer/popn buffer n)

Removes the last n bytes from the buffer. Returns the modified buffer.

buffer/push-byte cfunction
(buffer/push-byte buffer x)

Append a byte to a buffer. Will expand the buffer as necessary. Returns the modified buffer. Will throw an error if the buffer overflows.

buffer/push-string cfunction
(buffer/push-string buffer str)

Push a string onto the end of a buffer. Non string values will be converted to strings before being pushed. Returns the modified buffer. Will throw an error if the buffer overflows.

buffer/push-word cfunction
(buffer/push-word buffer x)

Append a machine word to a buffer. The 4 bytes of the integer are appended in twos complement, big endian order, unsigned. Returns the modified buffer. Will throw an error if the buffer overflows.

buffer/slice cfunction
(buffer/slice bytes &opt start end)

Takes a slice of a byte sequence from start to end. The range is half open, [start, end). Indexes can also be negative, indicating indexing from the end of the end of the array. By default, start is 0 and end is the length of the buffer. Returns a new buffer.

buffer? function
(buffer? x)

Check if x is a buffer.

bxor function
(bxor & xs)

Returns the bit-wise xor of all values in xs. Each in xs must be an integer.

bytes? function
(bytes? x)

Check if x is a string, symbol, or buffer.

case macro
(case dispatch & pairs)

Select the body that equals the dispatch value. When pairs has an odd number of arguments, the last is the default expression. If no match is found, returns nil.

cfunction? function
(cfunction? x)

Check if x a cfunction.

cli-main function
(cli-main args)

Entrance for the Janet CLI tool. Call this functions with the command line arguments as an array or tuple of strings to invoke the CLI interface.

comment macro
(comment &)

Ignores the body of the comment.

comp function
(comp & functions)

Takes multiple functions and returns a function that is the composition of those functions.

compile cfunction
(compile ast &opt env source)

Compiles an Abstract Syntax Tree (ast) into a janet function. Pair the compile function with parsing functionality to implement eval. Returns a janet function and does not modify ast. Throws an error if the ast cannot be compiled.

complement function
(complement f)

Returns a function that is the complement to the argument.

cond macro
(cond & pairs)

Evaluates conditions sequentially until the first true condition is found, and then executes the corresponding body. If there are an odd number of forms, the last expression is executed if no forms are matched. If there are no matches, return nil.

coro macro
(coro & body)

A wrapper for making fibers. Same as (fiber/new (fn [] ;body) :yi).

count function
(count pred ind)

Count the number of items in ind for which (pred item) is true.

debug function
(debug)

Throws a debug signal that can be caught by a parent fiber and used to inspect the running state of the current fiber. Returns nil.

debug/arg-stack cfunction
(debug/arg-stack fiber)

Gets all values currently on the fiber's argument stack. Normally, this should be empty unless the fiber signals while pushing arguments to make a function call. Returns a new array.

debug/break cfunction
(debug/break source byte-offset)

Sets a breakpoint with source a key at a given line and column. Will throw an error if the breakpoint location cannot be found. For example

	(debug/break "core.janet" 1000)

wil set a breakpoint at the 1000th byte of the file core.janet.

debug/fbreak cfunction
(debug/fbreak fun &opt pc)

Set a breakpoint in a given function. pc is an optional offset, which is in bytecode instructions. fun is a function value. Will throw an error if the offset is too large or negative.

debug/lineage cfunction
(debug/lineage fib)

Returns an array of all child fibers from a root fiber. This function is useful when a fiber signals or errors to an ancestor fiber. Using this function, the fiber handling the error can see which fiber raised the signal. This function should be used mostly for debugging purposes.

debug/stack cfunction
(debug/stack fib)

Gets information about the stack as an array of tables. Each table in the array contains information about a stack frame. The top most, current stack frame is the first table in the array, and the bottom most stack frame is the last value. Each stack frame contains some of the following attributes:

	:c - true if the stack frame is a c function invocation
	:column - the current source column of the stack frame
	:function - the function that the stack frame represents
	:line - the current source line of the stack frame
	:name - the human friendly name of the function
	:pc - integer indicating the location of the program counter
	:source - string with the file path or other identifier for the source code
	:slots - array of all values in each slot
	:tail - boolean indicating a tail call

debug/stacktrace cfunction
(debug/stacktrace fiber err)

Prints a nice looking stacktrace for a fiber. The error message err must be passed to the function as fiber's do not keep track of the last error they have thrown. Returns the fiber.

debug/unbreak cfunction
(debug/unbreak source line column)

Remove a breakpoint with a source key at a given line and column. Will throw an error if the breakpoint cannot be found.

debug/unfbreak cfunction
(debug/unfbreak fun &opt pc)

Unset a breakpoint set with debug/fbreak.

dec function
(dec x)

Returns x - 1.

deep-not= function
(deep-not= x y)

Like not=, but mutable types (arrays, tables, buffers) are considered equal if they have identical structure. Much slower than not=.

deep= function
(deep= x y)

Like =, but mutable types (arrays, tables, buffers) are considered equal if they have identical structure. Much slower than =.

def- macro
(def- name & more)

Define a private value that will not be exported.

default macro
(default sym val)

Define a default value for an optional argument. Expands to (def sym (if (= nil sym) val sym))

defglobal function
(defglobal name value)

Dynamically create a global def.

defmacro macro
(defmacro name & more)

Define a macro.

defmacro- macro
(defmacro- name & more)

Define a private macro that will not be exported.

defn macro
(defn name & more)

Define a function. Equivalent to (def name (fn name [args] ...)).

defn- macro
(defn- name & more)

Define a private function that will not be exported.

describe cfunction
(describe x)

Returns a string that is a human readable description of a value x.

dictionary? function
(dictionary? x)

Check if x a table or struct.

disasm cfunction
(disasm func)

Returns assembly that could be used be compile the given function.
func must be a function, not a c function. Will throw on error on a badly
typed argument.

distinct function
(distinct xs)

Returns an array of the deduplicated values in xs.

doc macro
(doc sym)

Shows documentation for the given symbol.

doc* function
(doc* sym)

Get the documentation for a symbol in a given environment.

doc-format function
(doc-format text)

Reformat text to wrap at a given line.

dofile function
(dofile path & args)

Evaluate a file and return the resulting environment.

drop function
(drop n ind)

Drop first n elements in an indexed type. Returns new indexed instance.

drop-until function
(drop-until pred ind)

Same as (drop-while (complement pred) ind).

drop-while function
(drop-while pred ind)

Given a predicate, remove elements from an indexed type that satisfy the predicate, and abort on first failure. Returns a new array.

dyn cfunction
(dyn key &opt default)

Get a dynamic binding. Returns the default value (or nil) if no binding found.

each macro
(each x ind & body)

Loop over each value in ind. Returns nil.

empty? function
(empty? xs)

Check if xs is empty.

env-lookup cfunction
(env-lookup env)

Creates a forward lookup table for unmarshalling from an environment. To create a reverse lookup table, use the invert function to swap keys and values in the returned table.

eprin cfunction
(eprin & xs)

Same as prin, but uses (dyn :err stderr) instead of (dyn :out stdout).

eprint cfunction
(eprint & xs)

Same as print, but uses (dyn :err stderr) instead of (dyn :out stdout).

eprintf cfunction
(eprintf fmt & xs)

Prints output formatted as if with (string/format fmt ;xs) to (dyn :err stderr).

error function
(error e)

Throws an error e that can be caught and handled by a parent fiber.

eval function
(eval form)

Evaluates a form in the current environment. If more control over the environment is needed, use run-context.

eval-string function
(eval-string str)

Evaluates a string in the current environment. If more control over the environment is needed, use run-context.

even? function
(even? x)

Check if x is even.

every? function
(every? ind)

Returns true if each value in is truthy, otherwise the first falsey value.

extreme function
(extreme order args)

Returns the most extreme value in args based on the function order. order should take two values and return true or false (a comparison). Returns nil if args is empty.

false? function
(false? x)

Check if x is false.

fiber/current cfunction
(fiber/current)

Returns the currently running fiber.

fiber/getenv cfunction
(fiber/getenv fiber)

Gets the environment for a fiber. Returns nil if no such table is set yet.

fiber/maxstack cfunction
(fiber/maxstack fib)

Gets the maximum stack size in janet values allowed for a fiber. While memory for the fiber's stack is not allocated up front, the fiber will not allocated more than this amount and will throw a stack-overflow error if more memory is needed. 

fiber/new cfunction
(fiber/new func &opt sigmask)

Create a new fiber with function body func. Can optionally take a set of signals to block from the current parent fiber when called. The mask is specified as a keyword where each character is used to indicate a signal to block. The default sigmask is :y. For example, 

	(fiber/new myfun :e123)

blocks error signals and user signals 1, 2 and 3. The signals are as follows: 

	a - block all signals
	d - block debug signals
	e - block error signals
	u - block user signals
	y - block yield signals
	0-9 - block a specific user signal

The sigmask argument also can take environment flags. If any mutually exclusive flags are present, the last flag takes precedence.

	i - inherit the environment from the current fiber
	p - the environment table's prototype is the current environment table

fiber/setenv cfunction
(fiber/setenv fiber table)

Sets the environment table for a fiber. Set to nil to remove the current environment.

fiber/setmaxstack cfunction
(fiber/setmaxstack fib maxstack)

Sets the maximum stack size in janet values for a fiber. By default, the maximum stack size is usually 8192.

fiber/status cfunction
(fiber/status fib)

Get the status of a fiber. The status will be one of:

	:dead - the fiber has finished
	:error - the fiber has errored out
	:debug - the fiber is suspended in debug mode
	:pending - the fiber has been yielded
	:user(0-9) - the fiber is suspended by a user signal
	:alive - the fiber is currently running and cannot be resumed
	:new - the fiber has just been created and not yet run

fiber? function
(fiber? x)

Check if x is a fiber.

file/close cfunction
(file/close f)

Close a file and release all related resources. When you are done reading a file, close it to prevent a resource leak and let other processes read the file.

file/fdopen cfunction
(file/fdopen fd &opt mode)

Create a file from an fd. fd is a platform specific file descriptor, and mode is a set of flags indicating the mode to open the file in. mode is a keyword where each character represents a flag. If the file cannot be opened, returns nil, otherwise returns the new file handle. Mode flags:

	r - allow reading from the file
	w - allow writing to the file
	a - append to the file
	b - open the file in binary mode (rather than text mode)
	+ - append to the file instead of overwriting it

file/fileno cfunction
(file/fileno f)

Return the underlying file descriptor for the file as a number.The meaning of this number is platform specific.

file/flush cfunction
(file/flush f)

Flush any buffered bytes to the file system. In most files, writes are buffered for efficiency reasons. Returns the file handle.

file/open cfunction
(file/open path &opt mode)

Open a file. path is an absolute or relative path, and mode is a set of flags indicating the mode to open the file in. mode is a keyword where each character represents a flag. If the file cannot be opened, returns nil, otherwise returns the new file handle. Mode flags:

	r - allow reading from the file
	w - allow writing to the file
	a - append to the file
	b - open the file in binary mode (rather than text mode)
	+ - append to the file instead of overwriting it

file/popen cfunction
(file/popen path &opt mode)

Open a file that is backed by a process. The file must be opened in either the :r (read) or the :w (write) mode. In :r mode, the stdout of the process can be read from the file. In :w mode, the stdin of the process can be written to. Returns the new file.

file/read cfunction
(file/read f what &opt buf)

Read a number of bytes from a file into a buffer. A buffer can be provided as an optional fourth argument, otherwise a new buffer is created. 'what' can either be an integer or a keyword. Returns the buffer with file contents. Values for 'what':

	:all - read the whole file
	:line - read up to and including the next newline character
	n (integer) - read up to n bytes from the file

file/seek cfunction
(file/seek f &opt whence n)

Jump to a relative location in the file. 'whence' must be one of

	:cur - jump relative to the current file location
	:set - jump relative to the beginning of the file
	:end - jump relative to the end of the file

By default, 'whence' is :cur. Optionally a value n may be passed for the relative number of bytes to seek in the file. n may be a real number to handle large files of more the 4GB. Returns the file handle.

file/write cfunction
(file/write f bytes)

Writes to a file. 'bytes' must be string, buffer, or symbol. Returns the file.

filter function
(filter pred ind)

Given a predicate, take only elements from an array or tuple for which (pred element) is truthy. Returns a new array.

find function
(find pred ind)

Find the first value in an indexed collection that satisfies a predicate. Returns nil if not found. Note there is no way to differentiate a nil from the indexed collection and a not found. Consider find-index if this is an issue.

find-index function
(find-index pred ind)

Find the index of indexed type for which pred is true. Returns nil if not found.

first function
(first xs)

Get the first element from an indexed data structure.

flatten function
(flatten xs)

Takes a nested array (tree), and returns the depth first traversal of that array. Returns a new array.

flatten-into function
(flatten-into into xs)

Takes a nested array (tree), and appends the depth first traversal of that array to an array 'into'. Returns array into.

for macro
(for i start stop & body)

Do a c style for loop for side effects. Returns nil.

freeze function
(freeze x)

Freeze an object (make it immutable) and do a deep copy, making child values also immutable. Closures, fibers, and abstract types will not be recursively frozen, but all other types will.

frequencies function
(frequencies ind)

Get the number of occurrences of each value in a indexed structure.

function? function
(function? x)

Check if x is a function (not a cfunction).

gccollect cfunction
(gccollect)

Run garbage collection. You should probably not call this manually.

gcinterval cfunction
(gcinterval)

Returns the integer number of bytes to allocate before running an iteration of garbage collection.

gcsetinterval cfunction
(gcsetinterval interval)

Set an integer number of bytes to allocate before running garbage collection. Low valuesi for interval will be slower but use less memory. High values will be faster but use more memory.

generate macro
(generate head & body)

Create a generator expression using the loop syntax. Returns a fiber that yields all values inside the loop in order. See loop for details.

gensym cfunction
(gensym)

Returns a new symbol that is unique across the runtime. This means it will not collide with any already created symbols during compilation, so it can be used in macros to generate automatic bindings.

get cfunction
(get ds key &opt dflt)

Get the value mapped to key in data structure ds, and return dflt or nil if not found. Similar to get, but will not throw an error if the key is invalid for the data structure unless the data structure is an abstract type. In that case, the abstract type getter may throw an error.

get-in function
(get-in ds ks &opt dflt)

Access a value in a nested data structure. Looks into the data structure via a sequence of keys.

getline cfunction
(getline &opt prompt buf)

Reads a line of input into a buffer, including the newline character, using a prompt. Returns the modified buffer. Use this function to implement a simple interface for a terminal program.

hash cfunction
(hash value)

Gets a hash value for any janet value. The hash is an integer can be used as a cheap hash function for all janet objects. If two values are strictly equal, then they will have the same hash value.

idempotent? function
(idempotent? x)

Check if x is a value that evaluates to itself when compiled.

identity function
(identity x)

A function that returns its first argument.

if-let macro
(if-let bindings tru &opt fal)

Make multiple bindings, and if all are truthy, evaluate the tru form. If any are false or nil, evaluate the fal form. Bindings have the same syntax as the let macro.

if-not macro
(if-not condition then &opt else)

Shorthand for (if (not condition) else then).

import macro
(import path & args)

Import a module. First requires the module, and then merges its symbols into the current environment, prepending a given prefix as needed. (use the :as or :prefix option to set a prefix). If no prefix is provided, use the name of the module as a prefix. One can also use :export true to re-export the imported symbols. If :exit true is given as an argument, any errors encountered at the top level in the module will cause (os/exit 1) to be called.

import* function
(import* path & args)

Function form of import. Same parameters, but the path and other symbol parameters should be strings instead.

in function
(get ds key &opt dflt)

Get a value from any associative data structure. Arrays, tuples, tables, structs, strings, symbols, and buffers are all associative and can be used with get. Order structures, name arrays, tuples, strings, buffers, and symbols must use integer keys. Structs and tables can take any value as a key except nil and return a value except nil. Byte sequences will return integer representations of bytes as result of a get call. If no values is found, will return dflt or nil if no default is provided.

inc function
(inc x)

Returns x + 1.

indexed? function
(indexed? x)

Check if x is an array or tuple.

int/s64 cfunction
(int/s64 value)

Create a boxed signed 64 bit integer from a string value.

int/u64 cfunction
(int/u64 value)

Create a boxed unsigned 64 bit integer from a string value.

int? cfunction
(int? x)

Check if x can be exactly represented as a 32 bit signed two's complement integer.

interleave function
(interleave & cols)

Returns an array of the first elements of each col, then the second, etc.

interpose function
(interpose sep ind)

Returns a sequence of the elements of ind separated by sep. Returns a new array.

invert function
(invert ds)

Returns a table of where the keys of an associative data structure are the values, and the values of the keys. If multiple keys have the same value, one key will be ignored.

janet/build string
The build identifier of the running janet program.

janet/config-bits number
The flag set of config options from janetconf.h which is used to check if native modules are compatible with the host program.

janet/version string
The version number of the running janet program.

juxt macro
(juxt & funs)

Macro form of juxt*. Same behavior but more efficient.

juxt* function
(juxt* & funs)

Returns the juxtaposition of functions. In other words, ((juxt* a b c) x) evaluates to [(a x) (b x) (c x)].

keep function
(keep pred ind)

Given a predicate, take only elements from an array or tuple for which (pred element) is truthy. Returns a new array of truthy predicate results.

keys function
(keys x)

Get the keys of an associative data structure.

keyword cfunction
(keyword & xs)

Creates a keyword by concatenating values together. Values are converted to bytes via describe if they are not byte sequences. Returns the new keyword.

keyword? function
(keyword? x)

Check if x is a keyword.

kvs function
(kvs dict)

Takes a table or struct and returns and array of key value pairs like @[k v k v ...]. Returns a new array.

last function
(last xs)

Get the last element from an indexed data structure.

length function
(length ds)

Returns the length or count of a data structure in constant time as an integer. For structs and tables, returns the number of key-value pairs in the data structure.

let macro
(let bindings & body)

Create a scope and bind values to symbols. Each pair in bindings is assigned as if with def, and the body of the let form returns the last value.

load-image function
(load-image image)

The inverse operation to make-image. Returns an environment.

loop macro
(loop head & body)

A general purpose loop macro. This macro is similar to the Common Lisp loop macro, although intentionally much smaller in scope. The head of the loop should be a tuple that contains a sequence of either bindings or conditionals. A binding is a sequence of three values that define something to loop over. They are formatted like:

 	binding :verb object/expression

 Where binding is a binding as passed to def, :verb is one of a set of keywords, and object is any janet expression. The available verbs are:

 	:iterate - repeatedly evaluate and bind to the expression while it is truthy.
 	:range - loop over a range. The object should be two element tuple with a start and end value, and an optional positive step. The range is half open, [start, end).
  	:down - Same as range, but loops in reverse.
  	:keys - Iterate over the keys in a data structure.
  	:pairs - Iterate over the keys value pairs in a data structure.
  	:in - Iterate over the values in an indexed data structure or byte sequence.
  	:generate - Iterate over values yielded from a fiber. Can be paired with the generator  function for the producer/consumer pattern.

  loop also accepts conditionals to refine the looping further. Conditionals are of  the form:

  	:modifier argument

  where :modifier is one of a set of keywords, and argument is keyword dependent.  :modifier can be one of:

  	:while expression - breaks from the loop if expression is falsey.
  	:until expression - breaks from the loop if expression is truthy.
  	:let bindings - defines bindings inside the loop as passed to the let macro.
  	:before form - evaluates a form for a side effect before of the next inner loop.
  	:after form - same as :before, but the side effect happens after the next inner loop.
  	:repeat n - repeats the next inner loop n times.
  	:when condition - only evaluates the loop body when condition is true.

  The loop macro always evaluates to nil.

macex function
(macex x &opt on-binding)

Expand macros completely. on-binding is an optional callback whenever a normal symbolic binding is encounter. This allows macros to easily see all bindings use by their arguments by calling macex on their contents. The binding itself is also replaced by the value returned by on-binding within the expand macro.

macex1 function
(macex1 x &opt on-binding)

Expand macros in a form, but do not recursively expand macros. See macex docs for info on on-binding.

make-env function
(make-env &opt parent)

Create a new environment table. The new environment will inherit bindings from the parent environment, but new bindings will not pollute the parent environment.

make-image function
(make-image env)

Create an image from an environment returned by require. Returns the image source as a string.

map function
(map f & inds)

Map a function over every element in an indexed data structure and return an array of the results.

mapcat function
(mapcat f ind)

Map a function over every element in an array or tuple and use array to concatenate the results.

marshal cfunction
(marshal x &opt reverse-lookup buffer)

Marshal a janet value into a buffer and return the buffer. The buffer can the later be unmarshalled to reconstruct the initial value. Optionally, one can pass in a reverse lookup table to not marshal aliased values that are found in the table. Then a forwardlookup table can be used to recover the original janet value when unmarshalling.

match macro
(match x & cases)

Pattern matching. Match an expression x against any number of cases. Easy case is a pattern to match against, followed by an expression to evaluate to if that case is matched. A pattern that is a symbol will match anything, binding x's value to that symbol. An array will match only if all of it's elements match the corresponding elements in x. A table or struct will match if all values match with the corresponding values in x. A tuple pattern will match if it's first element matches, and the following elements are treated as predicates and are true. Any other value pattern will only match if it is equal to x.

math/abs cfunction
(math/abs x)

Return the absolute value of x.

math/acos cfunction
(math/acos x)

Returns the arccosine of x.

math/asin cfunction
(math/asin x)

Returns the arcsine of x.

math/atan cfunction
(math/atan x)

Returns the arctangent of x.

math/atan2 cfunction
(math/atan2 y x)

Return the arctangent of y/x. Works even when x is 0.

math/ceil cfunction
(math/ceil x)

Returns the smallest integer value number that is not less than x.

math/cos cfunction
(math/cos x)

Returns the cosine of x.

math/cosh cfunction
(math/cosh x)

Return the hyperbolic cosine of x.

math/e number
The base of the natural log.

math/exp cfunction
(math/exp x)

Returns e to the power of x.

math/floor cfunction
(math/floor x)

Returns the largest integer value number that is not greater than x.

math/inf number
The number representing positive infinity

math/log cfunction
(math/log x)

Returns log base natural number of x.

math/log10 cfunction
(math/log10 x)

Returns log base 10 of x.

math/pi number
The value pi.

math/pow cfunction
(math/pow a x)

Return a to the power of x.

math/random cfunction
(math/random)

Returns a uniformly distributed random number between 0 and 1.

math/rng cfunction
(math/rng &opt seed)

Creates a Psuedo-Random number generator, with an optional seed. The seed should be an unsigned 32 bit integer. Do not use this for cryptography. Returns a core/rng abstract type.

math/rng-int cfunction
(math/rng-int rng &opt max)

Extract a random random integer in the range [0, max] from the RNG. If no max is given, the default is 2^31 - 1.

math/rng-uniform cfunction
(math/rng-seed rng seed)

Extract a random number in the range [0, 1) from the RNG.

math/seedrandom cfunction
(math/seedrandom seed)

Set the seed for the random number generator. 'seed' should be an integer.

math/sin cfunction
(math/sin x)

Returns the sine of x.

math/sinh cfunction
(math/sinh x)

Return the hyperbolic sine of x.

math/sqrt cfunction
(math/sqrt x)

Returns the square root of x.

math/tan cfunction
(math/tan x)

Returns the tangent of x.

math/tanh cfunction
(math/tanh x)

Return the hyperbolic tangent of x.

max function
(max & args)

Returns the numeric maximum of the arguments.

max-order function
(max-order & args)

Returns the maximum of the arguments according to a total order over all values.

mean function
(mean xs)

Returns the mean of xs. If empty, returns NaN.

merge function
(merge & colls)

Merges multiple tables/structs to one. If a key appears in more than one collection, then later values replace any previous ones. Returns a new table.

merge-into function
(merge-into tab & colls)

Merges multiple tables/structs into a table. If a key appears in more than one collection, then later values replace any previous ones. Returns the original table.

min function
(min & args)

Returns the numeric minimum of the arguments.

min-order function
(min-order & args)

Returns the minimum of the arguments according to a total order over all values.

module/cache table
Table mapping loaded module identifiers to their environments.

module/expand-path cfunction
(module/expand-path path template)

Expands a path template as found in module/paths for module/find. This takes in a path (the argument to require) and a template string, template, to expand the path to a path that can be used for importing files.

module/find function
(module/find path)

Try to match a module or path name from the patterns in module/paths. Returns a tuple (fullpath kind) where the kind is one of :source, :native, or image if the module is found, otherwise a tuple with nil followed by an error message.

module/loaders table
A table of loading method names to loading functions. This table lets require and import load many different kinds of files as module.

module/loading table
Table mapping currently loading modules to true. Used to prevent circular dependencies.

module/paths array
The list of paths to look for modules, templated for module/expand-path. Each element is a two element tuple, containing the path template and a keyword :source, :native, or :image indicating how require should load files found at these paths.

A tuple can also contain a third element, specifying a filter that prevents module/find from searching that path template if the filter doesn't match the input path. The filter can be a string or a predicate function, and is often a file extension, including the period.

nat? cfunction
(nat? x)

Check if x can be exactly represented as a non-negative 32 bit signed two's complement integer.

native cfunction
(native path &opt env)

Load a native module from the given path. The path must be an absolute or relative path on the file system, and is usually a .so file on Unix systems, and a .dll file on Windows. Returns an environment table that contains functions and other values from the native module.

neg? function
(neg? x)

Check if x is less than 0.

next cfunction
(next dict &opt key)

Gets the next key in a struct or table. Can be used to iterate through the keys of a data structure in an unspecified order. Keys are guaranteed to be seen only once per iteration if they data structure is not mutated during iteration. If key is nil, next returns the first key. If next returns nil, there are no more keys to iterate through. 

nil? function
(nil? x)

Check if x is nil.

not cfunction
(not x)

Returns the boolean inverse of x.

not= function
(not= & xs)

Return true if any values in xs are not equal, otherwise false.

not== function
(not== & xs)

Check if any values in xs are not numerically equal (3.0 not== 4). Returns a boolean.

number? function
(number? x)

Check if x is a number.

odd? function
(odd? x)

Check if x is odd.

one? function
(one? x)

Check if x is equal to 1.

or macro
(or & forms)

Evaluates to the last argument if all preceding elements are false, otherwise evaluates to true.

order< function
(order< & xs)

Check if xs is strictly increasing according to a total order over all values. Returns a boolean.

order<= function
(order<= & xs)

Check if xs is not decreasing according to a total order over all values. Returns a boolean.

order> function
(order> & xs)

Check if xs is strictly descending according to a total order over all values. Returns a boolean.

order>= function
(order>= & xs)

Check if xs is not increasing according to a total order over all values. Returns a boolean.

os/arch cfunction
(os/arch)

Check the ISA that janet was compiled for. Returns one of:

	:x86
	:x86-64
	:arm
	:aarch64
	:sparc
	:wasm
	:unknown

os/cd cfunction
(os/cd path)

Change current directory to path. Returns true on success, false on failure.

os/clock cfunction
(os/clock)

Return the number of seconds since some fixed point in time. The clock is guaranteed to be non decreasing in real time.

os/cwd cfunction
(os/cwd)

Returns the current working directory.

os/date cfunction
(os/date &opt time local)

Returns the given time as a date struct, or the current time if no time is given. Returns a struct with following key values. Note that all numbers are 0-indexed. Date is given in UTC unless local is truthy, in which case the date is formated for the local timezone.

	:seconds - number of seconds [0-61]
	:minutes - number of minutes [0-59]
	:hours - number of hours [0-23]
	:month-day - day of month [0-30]
	:month - month of year [0, 11]
	:year - years since year 0 (e.g. 2019)
	:week-day - day of the week [0-6]
	:year-day - day of the year [0-365]
	:dst - If Day Light Savings is in effect

os/dir cfunction
(os/dir dir &opt array)

Iterate over files and subdirectories in a directory. Returns an array of paths parts, with only the filename or directory name and no prefix.

os/execute cfunction
(os/execute args &opts flags env)

Execute a program on the system and pass it string arguments. Flags is a keyword that modifies how the program will execute.

	:e - enables passing an environment to the program. Without :e, the current environment is inherited.
	:p - allows searching the current PATH for the binary to execute. Without this flag, binaries must use absolute paths.

env is a table or struct mapping environment variables to values. Returns the exit status of the program.

os/exit cfunction
(os/exit &opt x)

Exit from janet with an exit code equal to x. If x is not an integer, the exit with status equal the hash of x.

os/getenv cfunction
(os/getenv variable)

Get the string value of an environment variable.

os/link cfunction
(os/link oldpath newpath &opt symlink)

Create a symlink from oldpath to newpath. The 3 optional paramater enables a hard link over a soft link. Does not work on Windows.

os/mkdir cfunction
(os/mkdir path)

Create a new directory. The path will be relative to the current directory if relative, otherwise it will be an absolute path.

os/rename cfunction
(os/rename oldname newname)

Rename a file on disk to a new path. Returns nil.

os/rm cfunction
(os/rm path)

Delete a file. Returns nil.

os/rmdir cfunction
(os/rmdir path)

Delete a directory. The directory must be empty to succeed.

os/setenv cfunction
(os/setenv variable value)

Set an environment variable.

os/shell cfunction
(os/shell str)

Pass a command string str directly to the system shell.

os/sleep cfunction
(os/sleep nsec)

Suspend the program for nsec seconds. 'nsec' can be a real number. Returns nil.

os/stat cfunction
(os/stat path &opt tab|key)

Gets information about a file or directory. Returns a table If the third argument is a keyword, returns only that information from stat. If the file or directory does not exist, returns nil. The keys are

	:dev - the device that the file is on
	:mode - the type of file, one of :file, :directory, :block, :character, :fifo, :socket, :link, or :other
	:permissions - A unix permission string like "rwx--x--x"
	:uid - File uid
	:gid - File gid
	:nlink - number of links to file
	:rdev - Real device of file. 0 on windows.
	:size - size of file in bytes
	:blocks - number of blocks in file. 0 on windows
	:blocksize - size of blocks in file. 0 on windows
	:accessed - timestamp when file last accessed
	:changed - timestamp when file last chnaged (permissions changed)
	:modified - timestamp when file last modified (content changed)

os/time cfunction
(os/time)

Get the current time expressed as the number of seconds since January 1, 1970, the Unix epoch. Returns a real number.

os/touch cfunction
(os/touch path &opt actime modtime)

Update the access time and modification times for a file. By default, sets times to the current time.

os/which cfunction
(os/which)

Check the current operating system. Returns one of:

	:windows
	:macos
	:web - Web assembly (emscripten)
	:linux
	:freebsd
	:openbsd
	:netbsd
	:posix - A POSIX compatible system (default)

pairs function
(pairs x)

Get the values of an associative data structure.

parser/byte cfunction
(parser/byte parser b)

Input a single byte into the parser byte stream. Returns the parser.

parser/clone cfunction
(parser/clone p)

Creates a deep clone of a parser that is identical to the input parser. This cloned parser can be used to continue parsing from a good checkpoint if parsing later fails. Returns a new parser.

parser/consume cfunction
(parser/consume parser bytes &opt index)

Input bytes into the parser and parse them. Will not throw errors if there is a parse error. Starts at the byte index given by index. Returns the number of bytes read.

parser/eof cfunction
(parser/eof parser)

Indicate that the end of file was reached to the parser. This puts the parser in the :dead state.

parser/error cfunction
(parser/error parser)

If the parser is in the error state, returns the message associated with that error. Otherwise, returns nil. Also flushes the parser state and parser queue, so be sure to handle everything in the queue before calling parser/error.

parser/flush cfunction
(parser/flush parser)

Clears the parser state and parse queue. Can be used to reset the parser if an error was encountered. Does not reset the line and column counter, so to begin parsing in a new context, create a new parser.

parser/has-more cfunction
(parser/has-more parser)

Check if the parser has more values in the value queue.

parser/insert cfunction
(parser/insert parser value)

Insert a value into the parser. This means that the parser state can be manipulated in between chunks of bytes. This would allow a user to add extra elements to arrays and tuples, for example. Returns the parser.

parser/new cfunction
(parser/new)

Creates and returns a new parser object. Parsers are state machines that can receive bytes, and generate a stream of janet values.

parser/produce cfunction
(parser/produce parser)

Dequeue the next value in the parse queue. Will return nil if no parsed values are in the queue, otherwise will dequeue the next value.

parser/state cfunction
(parser/state parser &opt key)

Returns a representation of the internal state of the parser. If a key is passed, only that information about the state is returned. Allowed keys are:

	:delimiters - Each byte in the string represents a nested data structure. For example, if the parser state is '(["', then the parser is in the middle of parsing a string inside of square brackets inside parentheses. Can be used to augment a REPL prompt.	:frames - Each table in the array represents a 'frame' in the parser state. Frames contain information about the start of the expression being parsed as well as the type of that expression and some type-specific information.

parser/status cfunction
(parser/status parser)

Gets the current status of the parser state machine. The status will be one of:

	:pending - a value is being parsed.
	:error - a parsing error was encountered.
	:root - the parser can either read more values or safely terminate.

parser/where cfunction
(parser/where parser)

Returns the current line number and column of the parser's internal state.

partial function
(partial f & more)

Partial function application.

partition function
(partition n ind)

Partition an indexed data structure into tuples of size n. Returns a new array.

peg/compile cfunction
(peg/compile peg)

Compiles a peg source data structure into a <core/peg>. This will speed up matching if the same peg will be used multiple times.

peg/match cfunction
(peg/match peg text &opt start & args)

Match a Parsing Expression Grammar to a byte string and return an array of captured values. Returns nil if text does not match the language defined by peg. The syntax of PEGs are very similar to those defined by LPeg, and have similar capabilities.

pos? function
(pos? x)

Check if x is greater than 0.

postwalk function
(postwalk f form)

Do a post-order traversal of a data structure and call (f x) on every visitation.

pp function
(pp x)

Pretty print to stdout or (dyn :out).

prewalk function
(prewalk f form)

Similar to postwalk, but do pre-order traversal.

prin cfunction
(prin & xs)

Same as print, but does not add trailing newline.

print cfunction
(print & xs)

Print values to the console (standard out). Value are converted to strings if they are not already. After printing all values, a newline character is printed. Use the value of (dyn :out stdout) to determine what to push characters to. Expects (dyn :out stdout) to be either a core/file or a buffer. Returns nil.

printf cfunction
(printf fmt & xs)

Prints output formatted as if with (string/format fmt ;xs) to (dyn :out stdout).

product function
(product xs)

Returns the product of xs. If xs is empty, returns 1.

propagate function
(propagate x fiber)

Propagate a signal from a fiber to the current fiber. The resulting stack trace from the current fiber will include frames from fiber. If fiber is in a state that can be resumed, resuming the current fiber will first resume fiber.

put function
(put ds key value)

Associate a key with a value in any mutable associative data structure. Indexed data structures (arrays and buffers) only accept non-negative integer keys, and will expand if an out of bounds value is provided. In an array, extra space will be filled with nils, and in a buffer, extra space will be filled with 0 bytes. In a table, putting a key that is contained in the table prototype will hide the association defined by the prototype, but will not mutate the prototype table. Putting a value nil into a table will remove the key from the table. Returns the data structure ds.

put-in function
(put-in ds ks v)

Put a value into a nested data structure. Looks into the data structure via a sequence of keys. Missing data structures will be replaced with tables. Returns the modified, original data structure.

quit function
(quit)

Tries to exit from the current repl or context. Does not always exit the application. Works by setting the :exit dynamic binding to true.

range function
(range & args)

Create an array of values [start, end) with a given step. With one argument returns a range [0, end). With two arguments, returns a range [start, end). With three, returns a range with optional step size.

reduce function
(reduce f init ind)

Reduce, also know as fold-left in many languages, transforms an indexed type (array, tuple) with a function to produce a value.

repl function
(repl &opt chunks onsignal env)

Run a repl. The first parameter is an optional function to call to get a chunk of source code that should return nil for end of file. The second parameter is a function that is called when a signal is caught.

require function
(require path & args)

Require a module with the given name. Will search all of the paths in module/paths, then the path as a raw file path. Returns the new environment returned from compiling and running the file.

resume function
(resume fiber &opt x)

Resume a new or suspended fiber and optionally pass in a value to the fiber that will be returned to the last yield in the case of a pending fiber, or the argument to the dispatch function in the case of a new fiber. Returns either the return result of the fiber's dispatch function, or the value from the next yield call in fiber.

reverse function
(reverse t)

Reverses the order of the elements in a given array or tuple and returns a new array.

run-context function
(run-context opts)

Run a context. This evaluates expressions of janet in an environment, and is encapsulates the parsing, compilation, and evaluation. opts is a table or struct of options. The options are as follows:

	 :chunks - callback to read into a buffer - default is getline
	 :on-parse-error - callback when parsing fails - default is bad-parse
	 :env - the environment to compile against - default is the current env
	 :source - string path of source for better errors - default is "<anonymous>"
	 :on-compile-error - callback when compilation fails - default is bad-compile
	 :evaluator - callback that executes thunks. Signature is (evaluator thunk source env where)
	 :on-status - callback when a value is evaluated - default is debug/stacktrace
	 :fiber-flags - what flags to wrap the compilation fiber with. Default is :ia.
	  :expander - an optional function that is called on each top level form before being compiled.

scan-number cfunction
(scan-number str)

Parse a number from a byte sequence an return that number, either and integer or a real. The number must be in the same format as numbers in janet source code. Will return nil on an invalid number.

seq macro
(seq head & body)

Similar to loop, but accumulates the loop body into an array and returns that. See loop for details.

setdyn cfunction
(setdyn key value)

Set a dynamic binding. Returns value.

short-fn macro
(short-fn arg)

fn shorthand.

 usage:

 	(short-fn (+ $ $)) - A function that double's its arguments.
 	(short-fn (string $0 $1)) - accepting multiple args
 	|(+ $ $) - use pipe reader macro for terse function literals
 	|(+ $&) - variadic functions

slice cfunction
(slice x &opt start end)

Extract a sub-range of an indexed data strutrue or byte sequence.

slurp function
(slurp path)

Read all data from a file with name path and then close the file.

some function
(some pred xs)

Returns false if all xs are false or nil, otherwise returns the first true value.

sort function
(sort xs [, by])

Sort an array in-place. Uses quick-sort and is not a stable sort.

sorted function
(sorted ind by)

Returns a new sorted array without modifying the old one.

spit function
(spit path contents &opt mode)

Write contents to a file at path. Can optionally append to the file.

stderr core/file
The standard error file.

stdin core/file
The standard input file.

stdout core/file
The standard output file.

string cfunction
(string & parts)

Creates a string by concatenating values together. Values are converted to bytes via describe if they are not byte sequences. Returns the new string.

string/ascii-lower cfunction
(string/ascii-lower str)

Returns a new string where all bytes are replaced with the lowercase version of themselves in ASCII. Does only a very simple case check, meaning no unicode support.

string/ascii-upper cfunction
(string/ascii-upper str)

Returns a new string where all bytes are replaced with the uppercase version of themselves in ASCII. Does only a very simple case check, meaning no unicode support.

string/bytes cfunction
(string/bytes str)

Returns an array of integers that are the byte values of the string.

string/check-set cfunction
(string/check-set set str)

Checks if any of the bytes in the string set appear in the string str. Returns true if some bytes in set do appear in str, false if no bytes do.

string/find cfunction
(string/find patt str)

Searches for the first instance of pattern patt in string str. Returns the index of the first character in patt if found, otherwise returns nil.

string/find-all cfunction
(string/find patt str)

Searches for all instances of pattern patt in string str. Returns an array of all indices of found patterns. Overlapping instances of the pattern are not counted, meaning a byte in string will only contribute to finding at most on occurrence of pattern. If no occurrences are found, will return an empty array.

string/format cfunction
(string/format format & values)

Similar to snprintf, but specialized for operating with janet. Returns a new string.

string/from-bytes cfunction
(string/from-bytes & byte-vals)

Creates a string from integer params with byte values. All integers will be coerced to the range of 1 byte 0-255.

string/has-prefix? cfunction
(string/has-prefix? pfx str)

Tests whether str starts with pfx.

string/has-suffix? cfunction
(string/has-suffix? sfx str)

Tests whether str ends with sfx.

string/join cfunction
(string/join parts &opt sep)

Joins an array of strings into one string, optionally separated by a separator string sep.

string/repeat cfunction
(string/repeat bytes n)

Returns a string that is n copies of bytes concatenated.

string/replace cfunction
(string/replace patt subst str)

Replace the first occurrence of patt with subst in the string str. Will return the new string if patt is found, otherwise returns str.

string/replace-all cfunction
(string/replace-all patt subst str)

Replace all instances of patt with subst in the string str. Will return the new string if patt is found, otherwise returns str.

string/reverse cfunction
(string/reverse str)

Returns a string that is the reversed version of str.

string/slice cfunction
(string/slice bytes &opt start end)

Returns a substring from a byte sequence. The substring is from index start inclusive to index end exclusive. All indexing is from 0. 'start' and 'end' can also be negative to indicate indexing from the end of the string.

string/split cfunction
(string/split delim str &opt start limit)

Splits a string str with delimiter delim and returns an array of substrings. The substrings will not contain the delimiter delim. If delim is not found, the returned array will have one element. Will start searching for delim at the index start (if provided), and return up to a maximum of limit results (if provided).

string/trim cfunction
(string/trim str &opt set)

Trim leading and trailing whitespace from a byte sequence. If the argument set is provided, consider only characters in set to be whitespace.

string/triml cfunction
(string/triml str &opt set)

Trim leading whitespace from a byte sequence. If the argument set is provided, consider only characters in set to be whitespace.

string/trimr cfunction
(string/trimr str &opt set)

Trim trailing whitespace from a byte sequence. If the argument set is provided, consider only characters in set to be whitespace.

string? function
(string? x)

Check if x is a string.

struct cfunction
(struct & kvs)

Create a new struct from a sequence of key value pairs. kvs is a sequence k1, v1, k2, v2, k3, v3, ... If kvs has an odd number of elements, an error will be thrown. Returns the new struct.

struct? function
(struct? x)

Check if x a struct.

sum function
(sum xs)

Returns the sum of xs. If xs is empty, returns 0.

symbol cfunction
(symbol & xs)

Creates a symbol by concatenating values together. Values are converted to bytes via describe if they are not byte sequences. Returns the new symbol.

symbol? function
(symbol? x)

Check if x is a symbol.

table cfunction
(table & kvs)

Creates a new table from a variadic number of keys and values. kvs is a sequence k1, v1, k2, v2, k3, v3, ... If kvs has an odd number of elements, an error will be thrown. Returns the new table.

table/clone cfunction
(table/clone tab)

Create a copy of a table. Updates to the new table will not change the old table, and vice versa.

table/getproto cfunction
(table/getproto tab)

Get the prototype table of a table. Returns nil if a table has no prototype, otherwise returns the prototype.

table/new cfunction
(table/new capacity)

Creates a new empty table with pre-allocated memory for capacity entries. This means that if one knows the number of entries going to go in a table on creation, extra memory allocation can be avoided. Returns the new table.

table/rawget cfunction
(table/rawget tab key)

Gets a value from a table without looking at the prototype table. If a table tab does not contain t directly, the function will return nil without checking the prototype. Returns the value in the table.

table/setproto cfunction
(table/setproto tab proto)

Set the prototype of a table. Returns the original table tab.

table/to-struct cfunction
(table/to-struct tab)

Convert a table to a struct. Returns a new struct. This function does not take into account prototype tables.

table? function
(table? x)

Check if x a table.

take function
(take n ind)

Take first n elements in an indexed type. Returns new indexed instance.

take-until function
(take-until pred ind)

Same as (take-while (complement pred) ind).

take-while function
(take-while pred ind)

Given a predicate, take only elements from an indexed type that satisfy the predicate, and abort on first failure. Returns a new array.

tarray/buffer cfunction
(tarray/buffer array|size)

Return typed array buffer or create a new buffer.

tarray/copy-bytes cfunction
(tarray/copy-bytes src sindex dst dindex &opt count)

Copy count elements (default 1) of src array from index sindex to dst array at position dindex memory can overlap.

tarray/length cfunction
(tarray/length array|buffer)

Return typed array or buffer size.

tarray/new cfunction
(tarray/new type size &opt stride offset tarray|buffer)

Create new typed array.

tarray/properties cfunction
(tarray/properties array)

Return typed array properties as a struct.

tarray/slice cfunction
(tarray/slice tarr &opt start end)

Takes a slice of a typed array from start to end. The range is half open, [start, end). Indexes can also be negative, indicating indexing from the end of the end of the typed array. By default, start is 0 and end is the size of the typed array. Returns a new janet array.

tarray/swap-bytes cfunction
(tarray/swap-bytes src sindex dst dindex &opt count)

Swap count elements (default 1) between src array from index sindex and dst array at position dindex memory can overlap.

trace cfunction
(trace func)

Enable tracing on a function. Returns the function.

true? function
(true? x)

Check if x is true.

try macro
(try body catch)

Try something and catch errors. Body is any expression, and catch should be a form with the first element a tuple. This tuple should contain a binding for errors and an optional binding for the fiber wrapping the body. Returns the result of body if no error, or the result of catch if an error.

tuple cfunction
(tuple & items)

Creates a new tuple that contains items. Returns the new tuple.

tuple/brackets cfunction
(tuple/brackets & xs)

Creates a new bracketed tuple containing the elements xs.

tuple/setmap cfunction
(tuple/setmap tup line column)

Set the sourcemap metadata on a tuple. line and column indicate should be integers.

tuple/slice cfunction
(tuple/slice arrtup [,start=0 [,end=(length arrtup)]])

Take a sub sequence of an array or tuple from index start inclusive to index end exclusive. If start or end are not provided, they default to 0 and the length of arrtup respectively.Returns the new tuple.

tuple/sourcemap cfunction
(tuple/sourcemap tup)

Returns the sourcemap metadata attached to a tuple, which is another tuple (line, column).

tuple/type cfunction
(tuple/type tup)

Checks how the tuple was constructed. Will return the keyword :brackets if the tuple was parsed with brackets, and :parens otherwise. The two types of tuples will behave the same most of the time, but will print differently and be treated differently by the compiler.

tuple? function
(tuple? x)

Check if x is a tuple.

type cfunction
(type x)

Returns the type of x as a keyword symbol. x is one of
	:nil
	:boolean
	:integer
	:real
	:array
	:tuple
	:table
	:struct
	:string
	:buffer
	:symbol
	:keyword
	:function
	:cfunction

or another symbol for an abstract type.

unless macro
(unless condition & body)

Shorthand for (when (not condition) ;body). 

unmarshal cfunction
(unmarshal buffer &opt lookup)

Unmarshal a janet value from a buffer. An optional lookup table can be provided to allow for aliases to be resolved. Returns the value unmarshalled from the buffer.

untrace cfunction
(untrace func)

Disables tracing on a function. Returns the function.

update function
(update ds key func & args)

Accepts a key argument and passes its associated value to a function. The key is the re-associated to the function's return value. Returns the updated data structure ds.

update-in function
(update-in ds ks f & args)

Update a value in a nested data structure by applying f to the current value. Looks into the data structure via a sequence of keys. Missing data structures will be replaced with tables. Returns the modified, original data structure.

use macro
(use & modules)

Similar to import, but imported bindings are not prefixed with a namespace identifier. Can also import multiple modules in one shot.

values function
(values x)

Get the values of an associative data structure.

varfn macro
(varfn name & body)

Create a function that can be rebound. varfn has the same signature as defn, but defines functions in the environment as vars. If a var 'name' already exists in the environment, it is rebound to the new function. Returns a function.

varglobal function
(varglobal name init)

Dynamically create a global var.

walk function
(walk f form)

Iterate over the values in ast and apply f to them. Collect the results in a data structure . If ast is not a table, struct, array, or tuple, returns form.

when macro
(when condition & body)

Evaluates the body when the condition is true. Otherwise returns nil.

when-let macro
(when-let bindings & body)

Same as (if-let bindings (do ;body)).

with macro
(with [binding ctor dtor] & body)

Evaluate body with some resource, which will be automatically cleaned up if there is an error in body. binding is bound to the expression ctor, and dtor is a function or callable that is passed the binding. If no destructor (dtor) is given, will call :close on the resource.

with-dyns macro
(with-dyns bindings & body)

Run a block of code in a new fiber that has some dynamic bindings set. The fiber will not mask errors or signals, but the dynamic bindings will be properly unset, as dynamic bindings are fiber local.

with-syms macro
(with-syms syms & body)

Evaluates body with each symbol in syms bound to a generated, unique symbol.

with-vars macro
(with-vars vars & body)

Evaluates body with each var in vars temporarily bound. Similar signature to let, but each binding must be a var.

yield function
(yield x)

Yield a value to a parent fiber. When a fiber yields, its execution is paused until another thread resumes it. The fiber will then resume, and the last yield call will return the value that was passed to resume.

zero? function
(zero? x)

Check if x is zero.

zipcoll function
(zipcoll keys vals)

Creates a table from two arrays/tuples. Returns a new table.