@playerthree/bench/series#

The reference series runner (SeriesRunner): schedules a SeriesSpec's trials over a GameMatchHost, records them durably in a SeriesStore and resumes after a restart.

Interfaces#

ClosableSeriesRunner#

Defined in: packages/bench/src/series.ts:21

The reference runner adds close(): stop executing without a terminal transition so another process resumes.

Extends#

• SeriesRunner

Methods#

abort()#

abort(owner, id): Promise<void>;

Defined in: packages/playerthree/src/arena.ts:144

Parameters#

Returns#

Promise<void>

Inherited from#

SeriesRunner.abort

close()#

close(): Promise<void>;

Defined in: packages/bench/src/series.ts:21

Returns#

Promise<void>

create()#

create(owner, spec): Promise<{
  id: string;
  revision: number;
}>;

Defined in: packages/playerthree/src/arena.ts:142

Parameters#

Returns#

Promise<{ id: string; revision: number; }>

Inherited from#

SeriesRunner.create

createShare()#

createShare(
   owner, 
   id, 
   policy
): Promise<{
  generation: number;
  token: string;
}>;

Defined in: packages/playerthree/src/arena.ts:152

Parameters#

Returns#

Promise<{ generation: number; token: string; }>

Inherited from#

SeriesRunner.createShare

export()#

export(
   access, 
   format, 
   revision?
): AsyncIterable<Uint8Array<ArrayBufferLike>>;

Defined in: packages/playerthree/src/arena.ts:149

Streams the full canonical playerthree.results JSON or the CSV ZIP with bounded memory.

Parameters#

Returns#

AsyncIterable<Uint8Array<ArrayBufferLike>>

Inherited from#

SeriesRunner.export

previewShare()#

previewShare(
   owner, 
   id, 
   policy
): Promise<ResultsSummary>;

Defined in: packages/playerthree/src/arena.ts:151

The exact shared projection a share with this policy would publish now, before creating the link.

Parameters#

Returns#

Promise<ResultsSummary>

Inherited from#

SeriesRunner.previewShare

results()#

results(access, revision?): Promise<ResultsSummary>;

Defined in: packages/playerthree/src/arena.ts:147

Bounded summary for live pages and polling; full raw data is only available through export.

Parameters#

Returns#

Promise<ResultsSummary>

Inherited from#

SeriesRunner.results

revokeShare()#

revokeShare(owner, id): Promise<void>;

Defined in: packages/playerthree/src/arena.ts:153

Parameters#

Returns#

Promise<void>

Inherited from#

SeriesRunner.revokeShare

setCommentaryConsent()#

setCommentaryConsent(
   owner, 
   id, 
   entrantId, 
   consent
): Promise<void>;

Defined in: packages/playerthree/src/arena.ts:154

Parameters#

Returns#

Promise<void>

Inherited from#

SeriesRunner.setCommentaryConsent

start()#

start(owner, id): Promise<void>;

Defined in: packages/playerthree/src/arena.ts:143

Parameters#

Returns#

Promise<void>

Inherited from#

SeriesRunner.start

updates()#

updates(access, afterRevision?): AsyncIterable<SeriesUpdate>;

Defined in: packages/playerthree/src/arena.ts:145

Parameters#

Returns#

AsyncIterable<SeriesUpdate>

Inherited from#

SeriesRunner.updates

SeriesRunnerOptions#

Defined in: packages/bench/src/series.ts:12

host runs single matches, binder binds entrants to seats, store persists series durably.

Properties#

Variables#

DEFAULT_SERIES_LIMITS#

const DEFAULT_SERIES_LIMITS: SeriesLimits;

Defined in: packages/bench/src/series.ts:10

Limits a series runner applies where SeriesRunnerOptions.limits sets none (bytes, ms).

Functions#

createSeriesRunner()#

function createSeriesRunner(options): ClosableSeriesRunner;

Defined in: packages/bench/src/series.ts:24

The sole generic evaluation scheduler. Hosts own individual matches, never series loops.

Parameters#

Returns#

ClosableSeriesRunner

recoverSeriesRunner()#

function recoverSeriesRunner(
   runner, 
   store, 
   now?
): Promise<void>;

Defined in: packages/bench/src/series.ts:329

Reclaim only expired execution leases; interrupted simulations become fresh attempts.

Parameters#

Returns#

Promise<void>