beamable-sdk / configs/BeamServerConfig / BeamServerConfig

Interface: BeamServerConfig¶

Defined in: src/configs/BeamServerConfig.ts:6

Configuration options for initializing the Beam Server SDK.

Extends¶

BeamBaseConfig

Properties¶

cid¶

cid: string

Defined in: src/configs/BeamBaseConfig.ts:8

Beamable Customer ID (CID).

Inherited from¶

BeamBaseConfig.cid

contentNamespaces?¶

optional contentNamespaces: string[]

Defined in: src/configs/BeamBaseConfig.ts:33

List of content namespaces to load. By default, only 'global' is loaded.

Inherited from¶

BeamBaseConfig.contentNamespaces

engine?¶

optional engine: string

Defined in: src/configs/BeamServerConfig.ts:8

Name of the engine (e.g., "Node", "Deno", "Express", "Hono").

engineVersion?¶

optional engineVersion: string

Defined in: src/configs/BeamServerConfig.ts:11

Version of the engine.

environment?¶

optional environment: BeamEnvironmentName

Defined in: src/configs/BeamBaseConfig.ts:18

The Beamable environment to connect to. Can be one of 'prod', 'stg', 'dev', or a custom environment name.

Default¶

'prod'

Inherited from¶

BeamBaseConfig.environment

gameVersion?¶

optional gameVersion: string

Defined in: src/configs/BeamBaseConfig.ts:30

Published version of the game.

Inherited from¶

BeamBaseConfig.gameVersion

instanceTag?¶

optional instanceTag: string

Defined in: src/configs/BeamBaseConfig.ts:27

Unique tag for instance-specific token storage synchronization.

Inherited from¶

BeamBaseConfig.instanceTag

pid¶

pid: string

Defined in: src/configs/BeamBaseConfig.ts:11

Beamable Project ID (PID).

Inherited from¶

BeamBaseConfig.pid

requester?¶

optional requester: HttpRequester

Defined in: src/configs/BeamBaseConfig.ts:21

Custom HTTP requester implementation.

Inherited from¶

BeamBaseConfig.requester

serverEvents?¶

optional serverEvents: ServerEventsConfig

Defined in: src/configs/BeamServerConfig.ts:23

Configuration for server-events.

services()?¶

optional services: (beam) => void

Defined in: src/configs/BeamServerConfig.ts:37

Optional callback invoked during Beam Server SDK initialization to register or configure server services.

Parameters¶

beam¶

BeamServer

Returns¶

void

Example¶

import { serverServices } from "beamable-sdk";

const config: BeamServerConfig = {
  services: serverServices,
};

tokenStorage?¶

optional tokenStorage: TokenStorage

Defined in: src/configs/BeamBaseConfig.ts:24

Custom token storage implementation.

Inherited from¶

BeamBaseConfig.tokenStorage

useSignedRequest?¶

optional useSignedRequest: boolean

Defined in: src/configs/BeamServerConfig.ts:20

Enables signing outgoing requests with a signature header.

Remarks¶

This option is only supported in Node.js environments. When running in a browser, this setting will be ignored.

Default Value¶

false