← Server functions

Server.Options

luastra/server

Server.Options is the checked configuration record accepted by the related SDK operation. Required fields establish the minimum contract, while optional fields preserve documented defaults when omitted.

Before you use it

Add luastra/server to this module's dependencies in luastra.json, then import it with require("luastra/server"). Declare rpc.call in luastra.json and configure a declared backend operation with a deployed trusted handler. Application code should prefer its generated operation function and decoder.

How it fits

The type describes request options, v2 limits, nullable values, public errors, or the tagged envelope-decoding result.

When to use it

Use Server.Options when a reusable variable or helper passes configuration to the related SDK operation. The exported type keeps optional and required fields aligned with the checked public contract.

Fields or definition

ParameterType / valuesDescription
deadlineMsnumber?Optional request deadline after which the operation fails predictably.
idempotencyKeystring?Optional stable key allowing a retryable operation to avoid duplicate effects.
retryboolean?Whether the host may apply its bounded retry policy for eligible failures.

What happens next

A checked request, result, limit, nullable-value, or public-error annotation.

Failures and fixes

Handle transport failure, envelope decode failure, and domain validation failure separately. The static web build does not deploy trusted backend handlers, credentials, or production operations for you.

Availability

Public-source alpha API in 0.5.0-alpha; production backend deployment remains application-owned.

Exact declaration

export type Options = { deadlineMs: number?, idempotencyKey: string?, retry: boolean? }

Continue learning

Next steps

Server.callServer.callV2

Complete inventory

View all pages in Server functions
← Previous: Server.RequestIdNext: Server.V2Limits →