Class GameProcessor

Class that processes games.

Hierarchy

GameProcessor

Index

Constructors

Properties

configs lineReader multithreadConfig readInHeader

Methods

addDataFromWorker checkConfig processPGN

Constructors

constructor

new GameProcessor(configs, multithreadCfg): GameProcessor
Parameters
- configs: AnalysisConfig[]
- multithreadCfg: MultithreadConfig
Returns GameProcessor
- Defined in src/core/GameProcessor.ts:30

Properties

configs

configs: GameProcessorAnalysisConfigFull[]

lineReader

lineReader: Interface

multithreadConfig

multithreadConfig: MultithreadConfig

readInHeader

readInHeader: boolean

Methods

`Private` addDataFromWorker

addDataFromWorker(err, result): void
If configured for multithreading, this function adds the result from a worker thread to the main thread.
Parameters
- err: Error
  
  Error object, if an error occured.
- result: WorkerMessage
  
  The result of the PGN parsing from the worker thread.
Returns void
- Defined in src/core/GameProcessor.ts:235

`Private` checkConfig

checkConfig(config): GameProcessorConfig
Parameters
- config: {
  cntGames?: number;
  filter?: ((data) => boolean);
  }
  - Optional cntGames?: number
  - Optional filter?: ((data) => boolean)
    - (data): boolean
      
      Parameters
      
      data: unknown
      
      Returns boolean
Returns GameProcessorConfig
- Defined in src/core/GameProcessor.ts:252

processPGN

processPGN(path): Promise<GameAndMoveCount[]>
Main function for parsing and analyzing.
Parameters
- path: string
  
  Path to the PGN file.
Returns Promise<GameAndMoveCount[]>
Count of processed games and moves.
- Defined in src/core/GameProcessor.ts:81

Generated using TypeDoc