Skip to content

RulesAdapter

neo-chess-board

Defined in: src/core/types.ts:287

Properties

optional header: (h) => void

Defined in: src/core/types.ts:321

Parameters

h

Record\<string, string>

Returns

void

supportsSanMoves?

optional supportsSanMoves: boolean

Defined in: src/core/types.ts:297

Indicates whether the adapter supports SAN/LAN string move submissions. Adapters should opt in explicitly to avoid accidental invocation with unsupported argument shapes.

Methods

canRedo()?

optional canRedo(): boolean

Defined in: src/core/types.ts:310

Returns

boolean

canUndo()?

optional canUndo(): boolean

Defined in: src/core/types.ts:309

Returns

boolean

getFEN()

getFEN(): string

Defined in: src/core/types.ts:289

Returns

string

getLastMove()?

optional getLastMove(): RulesMoveDetail | null

Defined in: src/core/types.ts:311

Returns

RulesMoveDetail | null

getPGN()?

optional getPGN(): string

Defined in: src/core/types.ts:320

Returns

string

getPgnNotation()?

optional getPgnNotation(): PgnNotation

Defined in: src/core/types.ts:325

Returns

PgnNotation

history()?

optional history(): string[]

Defined in: src/core/types.ts:322

Returns

string[]

inCheck()?

optional inCheck(): boolean

Defined in: src/core/types.ts:313

Returns

boolean

isCheckmate()?

optional isCheckmate(): boolean

Defined in: src/core/types.ts:312

Returns

boolean

isDraw()

isDraw(): boolean

Defined in: src/core/types.ts:315

Returns

boolean

isInsufficientMaterial()

isInsufficientMaterial(): boolean

Defined in: src/core/types.ts:316

Returns

boolean

isStalemate()?

optional isStalemate(): boolean

Defined in: src/core/types.ts:314

Returns

boolean

isThreefoldRepetition()

isThreefoldRepetition(): boolean

Defined in: src/core/types.ts:317

Returns

boolean

loadPgn()?

optional loadPgn(pgn): boolean

Defined in: src/core/types.ts:324

Parameters

pgn

string

Returns

boolean

move()

Call Signature

move(m): RulesMoveResponse | null | undefined

Defined in: src/core/types.ts:301

Execute a move. When a string is provided it should be interpreted as SAN/LAN notation.

Parameters
m
from

`${string}${number}`

promotion?

"b" | "r" | "q" | "n"

to

`${string}${number}`

Returns

RulesMoveResponse | null | undefined

Call Signature

move(notation): RulesMoveResponse | null | undefined

Defined in: src/core/types.ts:306

Parameters
notation

string

Returns

RulesMoveResponse | null | undefined

movesFrom()

movesFrom(square): Move[]

Defined in: src/core/types.ts:291

Parameters

square

`${string}${number}`

Returns

Move[]

redo()?

optional redo(): boolean

Defined in: src/core/types.ts:308

Returns

boolean

reset()?

optional reset(): void

Defined in: src/core/types.ts:318

Returns

void

setFEN()

setFEN(fen): void

Defined in: src/core/types.ts:288

Parameters

fen

string

Returns

void

toPgn()?

optional toPgn(includeHeaders?): string

Defined in: src/core/types.ts:323

Parameters

includeHeaders?

boolean

Returns

string

turn()

turn(): Color

Defined in: src/core/types.ts:290

Returns

Color

undo()

undo(): boolean

Defined in: src/core/types.ts:307

Returns

boolean