Docs / Reference

a9script authoring pack — text functions

The text 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.

slugify(text) — immediate

Turns a line of text into a slug that is safe in a URL or a file name: lower case, words joined by dashes, accented letters folded to their plain form and everything else dropped.

• text (string) — The text to convert. Only text — a number or a missing value is refused rather than turned into the slug of the word for it.

Answers: The slug. Text with nothing worth keeping — punctuation alone, an emoji — answers an empty string.

const slug = slugify(input.event.body.customer);
log("slug: " + slug);

template(text, values) — immediate

Fills {{key}} placeholders in a piece of text from an object of values. Nothing is escaped — the answer is plain text, so a value that has to be safe inside HTML or a URL must be made safe before it goes in.

• text (string) — The text to fill. {{name}} marks a placeholder and spacing inside the braces is ignored; a single brace is ordinary text.
• values (object) — What to put in, looked up by key. Text, numbers and booleans are written out; a key the object does not carry, and a value that is null or missing, render as nothing; an object value is refused, since it has no sensible written form.

Answers: The filled text.

const note = template("Hi {{name}}, order {{id}} is on its way.", {
  name: "Ada",
  id: input.event.body.id
});
log(note);

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-encoding — the encoding 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-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.