mirror of
https://github.com/FlipsideCrypto/DefinitelyTyped.git
synced 2026-02-06 19:07:08 +00:00
79545c9942
* Added @types/vndb * removed unnecessary reference to node * Removed package.json * Removed JSDoc type annotations * Removed unnecessary namespace from @types/vndb
44 lines
1.0 KiB
TypeScript
44 lines
1.0 KiB
TypeScript
// Type definitions for vndb 0.1
|
|
// Project: https://github.com/Permagate/vndb-reborn
|
|
// Definitions by: Pragun Saini <https://github.com/PragunSaini>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference types="node"/>
|
|
|
|
import { TLSSocket } from 'tls';
|
|
|
|
/**
|
|
* Used for creating a connection to VNDB API
|
|
*/
|
|
interface VNDB {
|
|
/**
|
|
* Connects to the VNDB API.
|
|
* Host and port are not required unless VNDB changes them.
|
|
* @param host VNDB host address
|
|
* @param port VNDB port
|
|
*/
|
|
start(host?: string, port?: number): Promise<vndb>;
|
|
}
|
|
|
|
/**
|
|
* Object containing the socket and methods to interact with it
|
|
*/
|
|
interface vndb {
|
|
socket: TLSSocket;
|
|
|
|
/**
|
|
* Send a message to the VNDB API, according to https://vndb.org/d11
|
|
* @param message message to send to the VNDB API
|
|
*/
|
|
write(message: string): Promise<string>;
|
|
|
|
/**
|
|
* Close the connection to the VNDB API
|
|
*/
|
|
end(): Promise<void>;
|
|
}
|
|
|
|
declare const VNDB: VNDB;
|
|
|
|
export = VNDB;
|