Class default

Index

Constructors

Accessors

depth lines position

Methods

[dispose] debug execute id move off on once ponder ponderhit register reset start stop

Constructors

constructor

new default(
path: string,
__namedParameters?: { config?: Record<string, unknown>; timeout?: number },
): default
Parameters
- path: string
- __namedParameters: { config?: Record<string, unknown>; timeout?: number } = {}
Returns default
- Defined in index.ts:104

Accessors

depth

get depth(): number | "infinite"
Returns number | "infinite"
- Defined in index.ts:145
set depth(value: number | "infinite"): void
Parameters
- value: number | "infinite"
Returns void
- Defined in index.ts:149

lines

get lines(): number
Returns number
- Defined in index.ts:153
set lines(value: number): void
Parameters
- value: number
Returns void
- Defined in index.ts:157

position

get position(): string
Returns string
- Defined in index.ts:161
set position(input: string): void
Parameters
- input: string
Returns void
- Defined in index.ts:165

Methods

[dispose]

"[dispose]"(): Promise<void>
Returns Promise<void>
- Defined in index.ts:172

debug

debug(on: boolean): Promise<void>
Parameters
- on: boolean
Returns Promise<void>
- Defined in index.ts:177

execute

execute(command: string): Promise<void>
Parameters
- command: string
Returns Promise<void>
- Defined in index.ts:181

id

id(): Promise<ID>
Returns Promise<ID>
- Defined in index.ts:190

move

move(input: string, options?: GoOptions): Promise<void>
Parameters
- input: string
- options: GoOptions = {}
Returns Promise<void>
- Defined in index.ts:200

off

off<K extends keyof Events>(
event: K,
listener: (data: Events[K]) => void | Promise<void>,
): void
Type Parameters
- K extends keyof Events
Parameters
- event: K
- listener: (data: Events[K]) => void | Promise<void>
Returns void
- Defined in index.ts:212

on

on<K extends keyof Events>(
event: K,
listener: (data: Events[K]) => void | Promise<void>,
): () => void
Type Parameters
- K extends keyof Events
Parameters
- event: K
- listener: (data: Events[K]) => void | Promise<void>
Returns () => void
- Defined in index.ts:219

once

once<K extends keyof Events>(event: K): Promise<Events[K]>
Type Parameters
- K extends keyof Events
Parameters
- event: K
Returns Promise<Events[K]>
- Defined in index.ts:226

ponder

ponder(move: string, options?: GoOptions): Promise<void>
Parameters
- move: string
- options: GoOptions = {}
Returns Promise<void>
- Defined in index.ts:230

ponderhit

ponderhit(): Promise<void>
Returns Promise<void>
- Defined in index.ts:249

register

register(options?: RegisterOptions): Promise<void>
Parameters
- Optionaloptions: RegisterOptions
Returns Promise<void>
- Defined in index.ts:267

reset

reset(): Promise<void>
Returns Promise<void>
- Defined in index.ts:276

start

start(options?: GoOptions): Promise<void>
Parameters
- options: GoOptions = {}
Returns Promise<void>
- Defined in index.ts:284

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in index.ts:320