mirror of https://github.com/jkjoy/sunpeiwen.git
45 lines
1.4 KiB
TypeScript
45 lines
1.4 KiB
TypeScript
// Type definitions for [~THE LIBRARY NAME~] [~OPTIONAL VERSION NUMBER~]
|
|
// Project: [~THE PROJECT NAME~]
|
|
// Definitions by: [~YOUR NAME~] <[~A URL FOR YOU~]>
|
|
|
|
/*~ This is the module template file for class modules.
|
|
*~ You should rename it to index.d.ts and place it in a folder with the same name as the module.
|
|
*~ For example, if you were writing a file for "super-greeter", this
|
|
*~ file should be 'super-greeter/index.d.ts'
|
|
*/
|
|
|
|
/*~ Note that ES6 modules cannot directly export class objects.
|
|
*~ This file should be imported using the CommonJS-style:
|
|
*~ import x = require('someLibrary');
|
|
*~
|
|
*~ Refer to the documentation to understand common
|
|
*~ workarounds for this limitation of ES6 modules.
|
|
*/
|
|
|
|
|
|
/*~ This declaration specifies that the class constructor function
|
|
*~ is the exported object from the file
|
|
*/
|
|
export = RPCClient;
|
|
|
|
/*~ Write your module's methods and properties in this class */
|
|
declare class RPCClient {
|
|
constructor(config: RPCClient.Config);
|
|
|
|
request<T>(action: String, params: Object, options?: Object): Promise<T>;
|
|
}
|
|
|
|
/*~ If you want to expose types from your module as well, you can
|
|
*~ place them in this block.
|
|
*/
|
|
declare namespace RPCClient {
|
|
export interface Config {
|
|
endpoint: string;
|
|
apiVersion: string;
|
|
accessKeyId: string;
|
|
accessKeySecret: string;
|
|
codes?: (string | number)[];
|
|
opts?: object;
|
|
}
|
|
}
|