Skip to content

Latest commit

 

History

History
82 lines (55 loc) · 5.01 KB

README.md

File metadata and controls

82 lines (55 loc) · 5.01 KB

Liveness

(liveness)

Overview

Are we still alive? I hope so :^)

Available Operations

  • get - Liveness check

get

This endpoint checks if the service is alive.

Example Usage

import { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.liveness.get();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SteamSetsCore } from "@steamsets/client-ts/core.js";
import { livenessGet } from "@steamsets/client-ts/funcs/livenessGet.js";

// Use `SteamSetsCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const steamSets = new SteamSetsCore({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await livenessGet(steamSets);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
options RequestOptions Used to set various options for making HTTP requests.
options.fetchOptions RequestInit Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.LivenessResponse>

Errors

Error Type Status Code Content Type
errors.ErrorModel 500 application/problem+json
errors.SDKError 4XX, 5XX */*