args

Read arguments supplied when starting a script.

args

Arguments

No arguments.

Returns

Frozen object with string values and no prototype. Also at.args.

Example

const limit = Number(args.limit || "5");
if (!Number.isInteger(limit) || limit < 1 || limit > 20) throw new Error("Invalid limit");

Notes

A runtime property, not a function. Module state is separate for each script iteration.

All JavaScript APIs · Automation playbook