beamable-sdk / configs/BeamConfig / BeamConfig

Interface: BeamConfig¶

Defined in: src/configs/BeamConfig.ts:5

Configuration options for initializing the Beam Client 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

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

gameEngine?¶

optional gameEngine: string

Defined in: src/configs/BeamConfig.ts:7

Name of the game engine (e.g., "Three.js", "Phaser", "Babylon", "PlayCanvas").

gameEngineVersion?¶

optional gameEngineVersion: string

Defined in: src/configs/BeamConfig.ts:10

Version of the game engine.

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

services()?¶

optional services: (beam) => void

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

Optional callback invoked during Beam Client SDK initialization to register or configure client services.

Parameters¶

beam¶

Beam

Returns¶

void

Example¶

import { clientServices } from "beamable-sdk";

const config: BeamConfig = {
  services: clientServices,
};

tokenStorage?¶

optional tokenStorage: TokenStorage

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

Custom token storage implementation.

Inherited from¶

BeamBaseConfig.tokenStorage