Home

Awesome

Capacitor Stockfish plugin

Stockfish chess engine interface for Ionic Capacitor.

Example usage

API

<docgen-index> </docgen-index> <docgen-api> <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

getMaxMemory()

getMaxMemory() => Promise<{ value: number; }>

Returns the maximum number of MB that can be used by the engine.

Returns: <code>Promise<{ value: number; }></code>


getCPUArch()

getCPUArch() => Promise<{ value: string; }>

Returns CPU architecture. Possible values are: armeabi, armeabi-v7a, arm64-v8a, x86, x86_64, mips, mips64.

Returns: <code>Promise<{ value: string; }></code>


start()

start() => Promise<void>

Initialize the engine. You must call this method before sending commands.


cmd(...)

cmd(options: { cmd: string; }) => Promise<void>

Sends a command to the engine. You can listen to the output using the "stockfish" window event.

ParamType
options<code>{ cmd: string; }</code>

exit()

exit() => Promise<void>

Stops the engine.


</docgen-api>