Options
All
  • Public
  • Public/Protected
  • All
Menu

Returns a list of regions available to this namespace. Regions are sorted by most optimal to least optimal. The player's IP address is used to calculate the regions' optimality.

example

Use a bare-bones client and the command you need to make an API call.

import { MatchmakerServiceClient, ListRegionsCommand } from "@rivet-gg/matchmaker"; // ES Modules import
// const { MatchmakerServiceClient, ListRegionsCommand } = require("@rivet-gg/matchmaker"); // CommonJS import
const client = new MatchmakerServiceClient(config);
const command = new ListRegionsCommand(input);
const response = await client.send(command);
see

ListRegionsCommandInput for command's input shape.

see

ListRegionsCommandOutput for command's response shape.

see

config for MatchmakerServiceClient's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: ListRegionsCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<ListRegionsCommandInput, ListRegionsCommandOutput>