Skip to content

README.md

Latest commit

 

History

History
84 lines (60 loc) · 5.94 KB

README.md

File metadata and controls

84 lines (60 loc) · 5.94 KB
Raw

App

Overview

Steam app (game) metadata and badges.

Available Operations

queueUpdate

Queue app update

Example Usage

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

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

async function run() {
  const result = await steamSets.app.queueUpdate({
    appIds: [],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SteamSetsCore } from "@steamsets/client-ts/core.js";
import { appQueueUpdate } from "@steamsets/client-ts/funcs/appQueueUpdate.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 appQueueUpdate(steamSets, {
    appIds: [],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("appQueueUpdate failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request components.V1AppQueueUpdateRequestBody ✔️ The request object to use for the request.
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.AppQueueUpdateResponse>

Errors

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