kokopu
Version:
A JavaScript/TypeScript library implementing the chess game rules and providing tools to read/write the standard chess file formats.
50 lines (49 loc) • 2.71 kB
TypeScript
/*!
* -------------------------------------------------------------------------- *
* *
* Kokopu - A JavaScript/TypeScript chess library. *
* <https://www.npmjs.com/package/kokopu> *
* Copyright (C) 2018-2026 Yoann Le Montagner <yo35 -at- melix.net> *
* *
* Kokopu is free software: you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public License *
* as published by the Free Software Foundation, either version 3 of *
* the License, or (at your option) any later version. *
* *
* Kokopu is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General *
* Public License along with this program. If not, see *
* <http://www.gnu.org/licenses/>. *
* *
* -------------------------------------------------------------------------- */
import { Database } from './database';
import { Game } from './game';
import { PGNWriteOptions } from './private_pgn/pgn_write_impl';
/**
* PGN parsing function.
*
* @param pgnString - String to parse.
*/
export declare function pgnRead(pgnString: string): Database;
/**
* PGN parsing function.
*
* @param pgnString - String to parse.
* @param gameIndex - Only the game corresponding to this index is parsed. Must be between 0 (inclusive) and the number of games in the PGN (exclusive).
* @throws {@link exception.InvalidPGN} if the corresponding game cannot be parsed, or if the given game index is larger than the number of games in the underlying PGN string.
*/
export declare function pgnRead(pgnString: string, gameIndex: number): Game;
/**
* PGN writing function.
*/
export declare function pgnWrite(game: Game, options?: PGNWriteOptions): string;
/**
* PGN writing function.
*
* @param games - Games to write.
*/
export declare function pgnWrite(games: Game[], options?: PGNWriteOptions): string;