# @types/node-uci

> TypeScript definitions for node-uci

Latest version **1.3.6** (published 2023-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/node-uci
pnpm add @types/node-uci
yarn add @types/node-uci
bun add @types/node-uci
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.3.6 |
| Published | 2023-11-21 |
| First published | 2020-05-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51438 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/node-uci
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-uci
- npm.io page: https://npm.io/package/@types/node-uci

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 1.3.6 (latest) — 2023-11-21
- 1.3.2 (ts3.8) — 2021-12-24
- 1.3.1 (ts3.6) — 2021-07-08
- 1.3.0 (ts2.9) — 2020-05-13
- 1.3.5 — 2023-11-07
- 1.3.4 — 2023-10-18
- 1.3.3 — 2023-09-23

## README

# Installation
> `npm install --save @types/node-uci`

# Summary
This package contains type definitions for node-uci (https://github.com/ebemunk/node-uci).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-uci.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-uci/index.d.ts)
````ts
// Minimum TypeScript Version: 3.0
/// <reference types="node" />

import { EventEmitter } from "events";

export interface SearchOptions {
    searchmoves?: readonly string[] | undefined;
    ponder?: boolean | undefined;
    wtime?: number | undefined;
    btime?: number | undefined;
    winc?: number | undefined;
    binc?: number | undefined;
    movestogo?: number | undefined;
    depth?: number | undefined;
    nodes?: number | undefined;
    mate?: number | undefined;
    movetime?: number | undefined;
}

export interface SearchResult {
    bestmove: string;
    info: readonly string[];
}

export class Engine {
    constructor(enginePath: string);
    getBufferUntil(fn: (str: string) => boolean): Promise<readonly string[]>;
    write(cmd: string): void;
    chain(): EngineChain;
    init(): Promise<Engine>;
    quit(): Promise<Engine>;
    isready(): Promise<Engine>;
    sendCmd(cmd: string): Promise<Engine>;
    setoption(name: string, value?: string): Promise<Engine>;
    ucinewgame(): Promise<Engine>;
    ponderhit(): Promise<Engine>;
    position(fen: string, moves?: readonly string[]): Promise<Engine>;
    go(sp: SearchOptions): Promise<SearchResult>;
    goInfinite(sp: SearchOptions): EventEmitter;
    stop(): Promise<SearchResult>;
}

export class EngineChain {
    constructor(engine: Engine);
    init(): EngineChain;
    setoption(name: string, value?: string): EngineChain;
    isready(): EngineChain;
    ucinewgame(): EngineChain;
    quit(): EngineChain;
    position(fen: string, moves?: readonly string[]): EngineChain;
    go(sp: SearchOptions): Promise<SearchResult>;
    exec(): unknown;
}

````

### Additional Details
 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by .

---
_Source: https://npm.io/package/@types/node-uci · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._