butlerd
Version:
Node.js library for butlerd, the butler daemon
87 lines (86 loc) • 2.47 kB
TypeScript
/**
* Params for Connection.New
*/
export interface ConnectionNewParams {
}
/**
* Result for Connection.New
*/
export interface ConnectionNewResult {
/** undocumented */
address: string;
}
/**
* Ask butler to listen for a new connection, so commands can
* be sent to it.
*/
export declare const ConnectionNew: import("../support").RequestCreator<ConnectionNewParams, ConnectionNewResult>;
/**
* Params for Version.Get
*/
export interface VersionGetParams {
}
/**
* Result for Version.Get
*/
export interface VersionGetResult {
/** Something short, like `v8.0.0` */
version: string;
/** Something long, like `v8.0.0, built on Aug 27 2017 @ 01:13:55, ref d833cc0aeea81c236c81dffb27bc18b2b8d8b290` */
versionString: string;
}
/**
* Retrieves the version of the butler instance the client
* is connected to.
*
* This endpoint is meant to gather information when reporting
* issues, rather than feature sniffing. Conforming clients should
* automatically download new versions of butler, see the **Updating** section.
*/
export declare const VersionGet: import("../support").RequestCreator<VersionGetParams, VersionGetResult>;
/**
* Params for Test.DoubleTwice
*/
export interface TestDoubleTwiceParams {
/** The number to quadruple */
number: number;
}
/**
* Result for Test.DoubleTwice
*/
export interface TestDoubleTwiceResult {
/** The input, quadrupled */
number: number;
}
/**
* Test request: asks butler to double a number twice.
* First by calling @@TestDoubleParams, then by
* returning the result of that call doubled.
*
* Use that to try out your JSON-RPC 2.0 over TCP implementation.
*/
export declare const TestDoubleTwice: import("../support").RequestCreator<TestDoubleTwiceParams, TestDoubleTwiceResult>;
/**
* Params for Test.Double
*/
export interface TestDoubleParams {
/** The number to double */
number: number;
}
/**
* Result for Test.Double
*/
export interface TestDoubleResult {
/** The number, doubled */
number: number;
}
/**
* Test request: return a number, doubled. Implement that to
* use @@TestDoubleTwiceParams in your testing.
*/
export declare const TestDouble: import("../support").RequestCreator<TestDoubleParams, TestDoubleResult>;
export declare const Progress: import("../support").NotificationCreator<{
progress: number;
eta: number;
bps: number;
}>;