Skip to content
Docs
Reference

Interface: LiveClientConfig

Interface: LiveClientConfig in @ticketlayer/live.

@ticketlayer/live


@ticketlayer/live / index / LiveClientConfig

Defined in: client.ts:149

Extended by#

Properties#

apiVersion?#

optional apiVersion?: string;

Defined in: client.ts:165

Override the dated API version sent as TL-Version.


baseUrl#

baseUrl: string;

Defined in: client.ts:151

Base URL of a Live deployment (or the sales surface directly).


headers?#

optional headers?: Record<string, string>;

Defined in: client.ts:167

Extra headers sent on every request (merged under per-call headers).


publishableKey?#

optional publishableKey?: string;

Defined in: client.ts:161

For embeds/native: the channel's publishable key (tlpk_…).


sessionMode?#

optional sessionMode?: "cookie" | "token";

Defined in: client.ts:159

Session transport:

  • 'cookie' (hosted web): the live_session httpOnly cookie travels automatically with credentials: 'include'; no token is held client-side.
  • 'token' (embeds / React Native / native): the session id is held by the SDK and sent as the X-Live-Session header.

tokenStorage?#

optional tokenStorage?: LiveTokenStorage;

Defined in: client.ts:163

Token storage for 'token' session mode (defaults to in-memory).