Interval

The Interval class is the entrypoint for defining actions and pages.

Usage

TypeScript

import path from "path";
import { Interval } from "@interval/sdk";

const interval = new Interval({
  apiKey: "<YOUR API KEY>" // get an API key at https://interval.com/dashboard/develop/keys
  routesDirectory: path.resolve(__dirname, "routes"),
});

interval.listen();

JavaScript

const path = require("path");
const { Interval } = require("@interval/sdk");

const interval = new Interval({
  apiKey: "<YOUR API KEY>" // get an API key at https://interval.com/dashboard/develop/keys
  routesDirectory: path.resolve(__dirname, "routes"),
});

interval.listen();

Python Experimental

import os
from interval_sdk import Interval

interval = Interval(
    api_key=os.environ["INTERVAL_API_KEY"],
)

interval.listen()

Props

TypeScript

apiKey

Required

string

Your API key. Get yours at https://interval.com/dashboard/develop/keys.

routesDirectory

Optional

string

The path to the directory of route definitions when using file-based routing.

routes

Optional

Record<string, Action | Page>

An object mapping string route slugs to Actions or Pages when defining routes inline.

logLevel

Optional

"quiet" | "info" | "debug"

Controls the type of logs emitted by Interval in the console's standard out and standard error. Defaults to 'info', set to 'quiet' to reduce output to only fatal errors, and 'debug' to include low-level internal debugging information.

retryIntervalMs

Optional

number

How long to wait in milliseconds before retrying a failed call to Interval. Defaults to 3000 (3 seconds).

pingIntervalMs

Optional

number

How often in milliseconds Interval is pinged to ensure a consistent connection. Defaults to 30000 (30 seconds).

pingTimeoutMs

Optional

number

How long to wait in milliseconds for an attempted ping to Interval before assuming it fails and trying again. Defaults to 3000 (3 seconds).

closeUnresponsiveTimeoutMs

Optional

number

How long to wait in milliseconds after receiving the last successful ping response before closing the connection and attempting to reconnect. Defaults to 180000 (3 minutes).

reinitializeBatchTimeoutMs

Optional

number

How long to wait in milliseconds before updating Interval with any programmatic changes made to defined routes. Defaults to 200.

JavaScript

apiKey

Required

string

Your API key. Get yours at https://interval.com/dashboard/develop/keys.

routesDirectory

Optional

string

The path to the directory of route definitions when using file-based routing.

routes

Optional

Record<string, Action | Page>

An object mapping string route slugs to Actions or Pages when defining routes inline.

logLevel

Optional

"quiet" | "info" | "debug"

Controls the type of logs emitted by Interval in the console's standard out and standard error. Defaults to 'info', set to 'quiet' to reduce output to only fatal errors, and 'debug' to include low-level internal debugging information.

retryIntervalMs

Optional

number

How long to wait in milliseconds before retrying a failed call to Interval. Defaults to 3000 (3 seconds).

pingIntervalMs

Optional

number

How often in milliseconds Interval is pinged to ensure a consistent connection. Defaults to 30000 (30 seconds).

pingTimeoutMs

Optional

number

How long to wait in milliseconds for an attempted ping to Interval before assuming it fails and trying again. Defaults to 3000 (3 seconds).

closeUnresponsiveTimeoutMs

Optional

number

How long to wait in milliseconds after receiving the last successful ping response before closing the connection and attempting to reconnect. Defaults to 180000 (3 minutes).

reinitializeBatchTimeoutMs

Optional

number

How long to wait in milliseconds before updating Interval with any programmatic changes made to defined routes. Defaults to 200.

Python Experimental

api_key

Required

str

Your API key. Get yours at https://interval.com/dashboard/develop/keys.

log_level

Optional

"quiet" | "info" | "debug"

Controls the type of logs emitted by Interval in the console's standard out and standard error. Defaults to 'info', set to 'quiet' to reduce output to only fatal errors, and 'debug' to include low-level internal debugging information.

retry_interval

Optional

float

How long to wait in seconds before retrying a failed call to Interval. Defaults to 3 seconds.

ping_interval

Optional

float

How often in seconds Interval is pinged to ensure a consistent connection. Defaults to 30 seconds.

ping_timeout

Optional

float

How long to wait in seconds for an attempted ping to Interval before assuming it fails and trying again. Defaults to 5 seconds.

reinitialize_batch_timeout

Optional

float

How long to wait in seconds before updating Interval with any programmatic changes made to defined routes. Defaults to 0.2 seconds.

Methods

TypeScript

listen()

Establish the persistent connection to Interval.

async safelyClose()

Safely close the connection to Interval, preventing new actions from being launched and closing the persistent connection afterward. Resolves when the connection is successfully safely closed.

immediatelyClose()

Immediately terminate the connection to interval, terminating any actions currently in progress.

JavaScript

listen()

Establish the persistent connection to Interval.

async safelyClose()

Safely close the connection to Interval, preventing new actions from being launched and closing the persistent connection afterward. Resolves when the connection is successfully safely closed.

immediatelyClose()

Immediately terminate the connection to interval, terminating any actions currently in progress.

Python Experimental

listen()

Establish the persistent connection to Interval.

async safely_close()

Safely close the connection to Interval, preventing new actions from being launched and closing the persistent connection afterward. Resolves when the connection is successfully safely closed.

async immediately_close()

Immediately terminate the connection to interval, terminating any actions currently in progress.

Examples

Safely shutting down a live deployment (rolling deploys)

TypeScript

Leverage the safelyClose method to ensure there are no service interruptions, lost progress, or malformed data when shutting down a previous version of a live deployment.

src/interval.ts

import path from "path";
import { Interval } from "@interval/sdk";

const interval = new Interval({
  apiKey: "<YOUR API KEY>" // get an API key at https://interval.com/dashboard/develop/keys
  routesDirectory: path.resolve(__dirname, "routes"),
});

interval.listen();

process.on('SIGINT', () => {
  interval
    .safelyClose()
    .then(() => {
      console.log("Safely shut down successfully.");
      process.exit(0);
    })
    .catch(err => {
      console.error(
        "Failed shutting down safely, forcibly closing connection."
      )
      interval.immediatelyClose();
      process.exit(0);
    });
});

JavaScript

Leverage the safelyClose method to ensure there are no service interruptions when shutting down a previous version of a live deployment.

src/interval.ts

const path = require("path");
const { Interval } = require("@interval/sdk");

const interval = new Interval({
  apiKey: "<YOUR API KEY>" // get an API key at https://interval.com/dashboard/develop/keys
  routesDirectory: path.resolve(__dirname, "routes"),
});

interval.listen();

process.on('SIGINT', () => {
  interval
    .safelyClose()
    .then(() => {
      console.log("Safely shut down successfully.");
      process.exit(0);
    })
    .catch(err => {
      console.error(
        "Failed shutting down safely, forcibly closing connection."
      )
      interval.immediatelyClose();
      process.exit(0);
    });
});

Python Experimental

Leverage the safely_close method to ensure there are no service interruptions when shutting down a previous version of a live deployment.

import asyncio, os
from interval_sdk import Interval

interval = Interval(
    api_key=os.environ["INTERVAL_API_KEY"],
)

loop = asyncio.get_event_loop()
task = loop.create_task(interval.listen_async())

close_task: asyncio.Task[None] | None = None


async def handle_close_inner():
    try:
        await interval.safely_close()
        print("Safely shut down successfully.")
    except Exception as err:
        print("Failed shutting down safely, forcibly closing connection.", file=sys.stderr)
        await interval.immediately_close()


def stop_loop(fut: asyncio.Future[None]):
    fut.result()
    loop.stop()


def handle_close():
    global close_task

    if close_task is not None:
        return

    close_task = loop.create_task(handle_close_inner())
    close_task.add_done_callback(stop_loop)


loop.add_signal_handler(signal.SIGINT, handle_close)

loop.run_forever()

Did this section clearly explain what you wanted to learn?