Docs / Reference

a9script authoring pack — encoding functions

The encoding functions, with their arguments and a line of real script each. Called by bare name; nothing is imported. A call marked pauses does real work outside the script: the run is saved, and continues on the next line with the result.

This is one part of the authoring pack — how a script is executed at all is the model part, and the other groups of functions are parts of their own. All of them are named at the end.

Generated — do not edit. Every block of script below is executed by the platform’s own test suite, and every error message is the one the platform produces today, so none of this can be what was true when someone last wrote it down.

base64Encode(text) — pauses

Text to base64, read as UTF-8 — so accented letters and emoji encode as themselves.

• text (string) — The text to encode.

Answers: The base64 text.

const encoded = base64Encode(input.event.body.customer);
log(encoded);

base64Decode(text) — pauses

Base64 back to text. Anything that is not base64, and anything whose bytes are not text, is refused — a half-decoded string full of replacement characters is corruption that looks like data.

• text (string) — The base64 to decode.

Answers: The decoded text.

const decoded = base64Decode("aGVsbG8=");
log(decoded); // hello

hexEncode(text) — pauses

Text to lower-case hexadecimal, read as UTF-8 — two characters per byte.

• text (string) — The text to encode.

Answers: The hexadecimal text.

log(hexEncode("hi")); // 6869

hexDecode(text) — pauses

Hexadecimal back to text. An odd number of characters, anything outside 0-9a-f, and bytes that are not text are all refused.

• text (string) — The hexadecimal to decode.

Answers: The decoded text.

log(hexDecode("6869")); // hi

The rest of this pack

The page above is everything that is true only HERE. Ask for these parts by name for the rest:

• model — how a script is executed, the shape of its input, the rules enforced while it runs, and the mistakes that do not work here.
• functions-core — the core functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-crypto — the crypto functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-text — the text functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-number — the numbers functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-structured — the structured data functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-document — the documents functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-markdown — the markdown functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-datetime — the date & time functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-email — the email functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-blob — the files functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-mapping — the mapping functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-dataset — the datasets functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-state — the state functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-pagination — the pagination functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-control — the run control functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• functions-functions — the config functions — what each one does, its arguments, whether it pauses the run, and a line of real script.
• mistakes — the habits from general JS that do not work here — each with the exact error it produces and the shape to write instead.
• standard-library — every built-in the language itself provides — JSON, Math, Object, String, Array, Number, Map, Set, Date, RegExp and the bare globals — one line each, with an example and its answer.