edge.save.limit() - Playground API

Syntax

await edge.save.limit()
await edge.save.limit(options)

Parameters

options Optional

An object with these properties:

message Optional: A note for this deployment. It is converted to a string, and an empty value sends no note. The note is shown as 💬 in the list of versions and returned as message by edge.versions(). The platform joins every run of whitespace, including newlines, into one space, so a note is always a single line. The length is not limited, but keep it to one short line, about 200 characters. With path: '/del' the note is kept with the deletion Experimental.
path Optional: A string that selects the action. '/put', the default, deploys. '/del' deletes the deployments of every route in Code.D, like Edge: Delete…. Pass exactly one of the two: any other value selects the delete action.
confirmed Optional: A boolean value: true skips the confirmation dialog of a delete, Delete this deployment permanently?. It has no effect on a deploy. The default is false.

Return value

A Promise that resolves to a result object. Failures that the platform reports arrive in the result; they are not thrown.

{
  ok: true,           // true only when reason is 'success'
  action: 'deploy',   // or 'delete'
  reason: 'success',  // or 'error', 'busy', 'cancelled', 'missing-user', 'no-routes'
  response: {         // not present for busy, cancelled, missing-user and no-routes
    D: { 'my-site': { success: true } }   // one entry per route
  }
}

ok

A boolean value: true only when reason is 'success'.

action

'deploy' or 'delete'.

reason

Why the call ended:

'success': The deploy service answered without a global error. This does not mean that every route succeeded: read response.D.
'error': The request failed. The cause is in error.
'busy': A deploy or delete was already running. No request was sent.
'cancelled': You closed the Code dialog or the delete confirmation without confirming.
'missing-user': You are not signed in. The account dialog opens, and the call resolves at once.
'no-routes': A delete was requested while Code.D is empty.

response Optional

An object, present when the deploy service answered. Its D member has one entry per route: { success: true, … } for a route that was published or deleted, or { error } for a route that failed. File bodies are replaced by the string '<REDACTED>'. Members other than D are not part of the API and may change.

error Optional

A string, or an array of { message, route?, domain?, … } objects for failures of single routes. See Exceptions.

retried Optional

true when the result comes from the automatic retry described in Usage notes.

Exceptions

The promise does not reject for failures that the platform reports. They arrive as reason: 'error', with the cause in error, or as one of the other reasons. These messages occur in a deploy or a delete:

Message	Meaning
`route is not yours`	Another account owns the route, or you are an editor whose Editors list differs from the deployed one. Carries `route`. One foreign route stops the whole call.
`common owner required`	All routes of one deploy must have the same owner. Carries `routes` and `owners`.
`storage quota exhausted`	The account's deployment quota is used up: the total size of its deployments or the number of its edge workers. The message does not say which. Carries `account`. See Limits and quotas.
`invalid old size`	Another deploy changed the route in the meantime. Try again.
`route domain is not yours`	The route's domain is claimed by another account. Carries `route` and `domain`. A domain that nobody has claimed yet is claimed for you instead; see Usage notes.
`NOT_SIGNED_IN_AS_OWNER`	Your session no longer matches your account. The playground shows Your session has expired. Sign in again to deploy! and signs you out.
`Edge network is not available for public.`	The platform's answer was not JSON. This is a string, not an object.

A request that takes longer than 60 seconds ends with an error as well. Deploy requests sent too quickly show Rate limit hit. Try again later! in a toast.

Usage notes

It can wait for a person. The call runs these checks in order:
1. Not signed in: the account dialog opens, the toast says Sign in to deploy. (or delete.), and the call resolves missing-user at once.
2. A delete with no routes resolves no-routes.
3. A deploy with no routes shows No routes to deploy. and opens the Code dialog on the first route, with a Deploy button. The call resolves cancelled unless you save at least one route, and otherwise goes on.
4. A delete without confirmed: true asks for confirmation. Declining resolves cancelled.
A route that fails with a fixable error opens the Code dialog again, and the call retries once if you press Deploy. An io.eval.js that awaits the call waits for the person who answers.
ok is not a verdict on each route. Read response.D[route]: it holds success or error. A call can have ok: true while one route failed.
Check the worker. If an edge worker fails to compile or upload, the playground shows the error in a toast and leaves out the route/: link of that route. Do not rely on success alone to know that the worker is live; open route/: or request it.
What is deployed. The request carries the whole playground state: source, title, routes, editors, layout, selections and output settings. Whatever the editor holds at that moment is what route/? reopens later.
Side effects. Every call ends the current undo burst and adds an undo stop, even one that ends busy or cancelled. While it runs, closing the tab asks for confirmation, and a Deploying… toast shows. The playground compiles the workers first, and bundles the static imports of an edge worker (60 seconds at most).
After a success the playground requests each deployed route once, shows a toast per route with a link, and adds a second link to route/: when a worker was deployed. A toast says <owner> allowed you as editor when an editor deployed.
Domains. The first deploy to a route whose domain nobody has claimed claims it for your account, subject to the domain quota, and retries once; the result then has retried: true. Domains and subdomains has the rules.
Owners and editors. The first deployer of a route is its owner. Later deploys are accepted from the owner or from a matching editor, and an editor's deploy is charged to the owner's quota. Only the owner can delete, and an editor never can. All routes are checked first: one foreign route stops the whole delete.
Deleting removes the route's worker and stored files and frees their quota. It keeps the version history, the past screenshots and your domain claim, and the route then answers with a 404 page. The history is not erased.
One at a time. Start the next call after the previous one has resolved: a call made while another is running resolves busy.
History. Every deploy is recorded as a version, a few seconds after the call resolves. See edge.versions() and Versions and undo.

Examples

Deploying and checking each route

Write this to io.eval.js and read io.eval.json. It lists one outcome per route, because ok alone is not enough.

const r = await edge.save.limit({ message: 'Tighten hero spacing' });
r.ok ? Object.entries(r.response.D).map(([route, v]) => [route, v.error ?? (v.success ? 'deployed' : 'not deployed')]) : r

Deleting the deployments

await edge.save.limit({ path: '/del' })                   // asks for confirmation
await edge.save.limit({ path: '/del', confirmed: true })  // does not ask

Specifications

Not part of any specification. edge.save.limit() is an RTCode.io playground function that deploys to RTEdge.net.

Availability

Feature	Playground	RTEdge.net	Notes
`edge.save.limit()`	Yes	No	Needs a signed-in account and at least one route. Opens dialogs when a route is missing or wrong.
`message`	Yes	No	On a delete, the note is Experimental.
`path: '/del'`	Yes	No	Owner only. Asks for confirmation unless `confirmed: true`.

`edge.save.limit()`