Handling requests

When a Runnable is used to handle an HTTP request, Atmo will bind that request to the Runnable. The req or request namespace of the Runnable API can then be used to access all of the information about the request. Note if the Runnable is not being used to handle a request, then all methods in the req namespace will return empty or an error.

Rust

In Rust these methods are available under the req module:

# Use the "req" module
use suborbital::req;

# Invoke the "State" method
req::state(…)

JavaScript/TypeScript

In JavaScript and TypeScript the methods live on the request import:

import { request } from "@suborbital/runnable"

request.state(…)

AssemblyScript

In AssemblyScript all methods are prefixed with req:

// Import then invoke "State" method
import { reqState } from '@suborbital/suborbital'

reqState(…)

Swift

In Swift these methods are prefixed with Req:

// Invoke the "State" method
Suborbital.ReqState(…)

The following namespace methods are available:

Method

Returns the HTTP method for the request:

Rust

STATUS: STABLE

pub fn method() -> String

JavaScript & TypeScript

STATUS: BETA

request.method(): string

AssemblyScript

STATUS: BETA

function reqMethod(): string

Swift

STATUS: PREVIEW

public func ReqMethod() -> String

URL

Returns the full URL of the request:

Rust

STATUS: STABLE

pub fn url() -> String

JavaScript & TypeScript

STATUS: BETA

request.url(): string

AssemblyScript

STATUS: BETA

function reqURL(): string

Swift

STATUS: PREVIEW

public func ReqURL() -> String

ID

Returns the unique ID assigned to the request by Atmo:

Rust

STATUS: STABLE

pub fn id() -> String

JavaScript & TypeScript

STATUS: BETA

// Get request body as a JavaScript string
request.body(): string

// Get request body as raw bytes
request.bodyBytes(): Uint8Array

AssemblyScript

STATUS: BETA

function reqBody(): ArrayBuffer

Swift

STATUS: PREVIEW

public func ReqBodyRaw() -> String

Body Field

Returns the value for the provided key, if the request body is formatted as JSON:

Rust

STATUS: STABLE

pub fn body_field(key: &str) -> String

JavaScript & TypeScript

STATUS: BETA

request.bodyField(key: string): string

AssemblyScript

STATUS: BETA

function reqBodyField(key: string): string

Swift

STATUS: PREVIEW

public func ReqBodyField(key: String) -> String

Header

Returns the header value for the provided key:

Rust

STATUS: STABLE

pub fn header(key: &str) -> String

JavaScript & TypeScript

STATUS: BETA

request.header(key: string): string

AssemblyScript

STATUS: BETA

function reqHeader(key: string): string

Swift

STATUS: PREVIEW

public func ReqHeader(key: String) -> String

URL Parameter

Returns the value of a given parameter when a handler is using parametrized endpoints such as /api/v1/user/:uuid.

Rust

STATUS: STABLE

pub fn url_param(key: &str) -> String

JavaScript & TypeScript

STATUS: BETA

request.urlParam(key: string): string

AssemblyScript

STATUS: BETA

function reqURLParam(key: string): string

Swift

STATUS: PREVIEW

public func ReqParam(key: String) -> String

State

Returns the value from request state for the provided key:

Rust

STATUS: STABLE

pub fn state(key: &str) -> Option<String>

JavaScript & TypeScript

STATUS: BETA

// Value of the state key as a JavaScript string
request.state(key: string): string

// Value of the state key as raw bytes
request.stateBytes(key: string): Uint8Array

AssemblyScript

STATUS: BETA

function reqState(key: string): string

Swift

STATUS: PREVIEW

public func State(key: String) -> String