Serve

The serve module provides all functionalities related to serving resources from your app to your public web-server.

Serve

To publish files for public access, use server:

// Publish artifact or dataset
serve file.png, false;

// Publish artifact or dataset in compressed form
serve file.png, true;

The compressed version of your published file can be access by adding the -compressed suffix.

https://ny-1.frames.sh/v/38129/file.png-compressed

Clear

To remove all published files in your application's web-server, use clear:

// Clear all published files
clear;

// Serve new files
serve file.png, true;

Template

Use a frame template as a response. A snapshot of the template is created and used as the frame image - this can be overridden by providing an existing image on the parameters. See the examples below.

In some cases, templates may require some delay before a render can be taken therefore a delay parameter is available set a delay duration in milliseconds i.e. template <image override>, <delay>, <template html string>;

// Use a template and provide it as a response to requests
template null, 0, welcome.html;
respond @@;

// Use a template and override the frame image with an image specified
template https://i.imgur.com/image.png, 0, welcome.html;
respond @@;

// Use a template and override the frame image with a published image that exist in the app's dataaset
template {$app_url}/image.png, 0, welcome.html;
respond @@;

Access

The access function allows access to a JSON object. This function is useful for accessing variables in a POST request's body.

// POST request body
{
    a: {
        b: 1
    },
    c: 2,
    d: [
        3,
        4,
        5
    ],
    e: [
        {
            f: 1
        },
        {
            g: 2
        }
    ]
}

// Access key b
access a.b;
variable b = @@;

// Access the 2nd item in e
access e.1.g;
variable g = @@;

Post Requests

When sending a POST request to your application's web-server, the request is added to a queue and processed in a first-come-first-serve basis. The POST request's body is converted into variables in your application.

Respond

To respond to requests, simply call the respond method:

//! Respond with a text
respond Hello World;

//! Respond with HTML
respond ;
<html>
    <head>
        <title>
            Hello
        </title>
    </head>
    <body>
        World
    </body>
</html>

There are two types of POST endpoints in your app's API.

Endpoint

Route

Description

Default (POST)

Raw (POST)

/raw

Responses from the /raw route are delivered as it is written in your application.

Response Object

{
    type: 'Success' | 'Failure',
    reason: string,
    message: string (response)
}

Redirect

For all sorts of purposes a redirect response can be made to the caller on either default or raw POST requests.

To respond with a redirect, simple call the redirect method:

// Redirect caller to a link
redirect https://www.example.com;

Questions?

PreviousHTTP NextAirstack

Last updated 5 months ago

// Use a template and provide it as a response to requests template null, 0, welcome.html; respond @@; // Use a template and override the frame image with an image specified template https://i.imgur.com/image.png, 0, welcome.html; respond @@; // Use a template and override the frame image with a published image that exist in the app's dataaset template {$app_url}/image.png, 0, welcome.html; respond @@;

// POST request body { a: { b: 1 }, c: 2, d: [ 3, 4, 5 ], e: [ { f: 1 }, { g: 2 } ] } // Access key b access a.b; variable b = @@; // Access the 2nd item in e access e.1.g; variable g = @@;

//! Respond with a text respond Hello World; //! Respond with HTML respond ; <html> <head> <title> Hello </title> </head> <body> World </body> </html>