index.d.ts

export interface Options {
  conversionTimeout?: number;
  conversionTimeoutDelta?: number;
  uploadTimeout?: number;
  downloadTimeout?: number;
  proxy?: object;
  baseUri?: string;
  keepAlive?: boolean;
}

export interface ResultFile {
  readonly url: string;
  readonly fileName: string;
  readonly fileSize: number;
  save(filePath: string): Promise<string>;
}

export interface Result {
  readonly response: object;
  readonly conversionCost: number;
  readonly jobId?: string;
  readonly file: ResultFile;
  readonly files: [ResultFile];
  saveFiles(path: string): Promise<[string]>;
}

export interface UploadResult {
  readonly fileId: string;
  readonly fileName: string;
  readonly fileExt: string;
  toString(): string;
}

export interface Client {
  get(path: string, params?: any, timeout?: number): Promise<any>;
  post(path: string, params: any, timeout?: number): Promise<any>;
  download(url: string, path: string): Promise<string>;
  upload(stream: string | NodeJS.ReadableStream, fileName: string): Promise<UploadResult>;
}

export class ConvertAPI {
  client: Client;
  constructor (credentials: string, options?: Options);
  convert(toFormat: string, params: object, fromFormat?: string, conversionTimeout?: number): Promise<Result>;
  getUser(): Promise<object>;
  upload(source: string | NodeJS.ReadableStream, fileName?: string): Promise<UploadResult>;
}

export default ConvertAPI;