tauri-pty/dist/types/index.d.ts

API package for tauri-plugin-pty

export declare function spawn(file: string, args: string[] | string, options: IPtyForkOptions | IWindowsPtyForkOptions): IPty;
export interface IBasePtyForkOptions {
    name?: string;
    cols?: number;
    rows?: number;
    cwd?: string;
    env?: {
        [key: string]: string | undefined;
    };
    encoding?: string | null;
    handleFlowControl?: boolean;
    flowControlPause?: string;
    flowControlResume?: string;
}
export interface IPtyForkOptions extends IBasePtyForkOptions {
    uid?: number;
    gid?: number;
}
export interface IWindowsPtyForkOptions extends IBasePtyForkOptions {
    useConpty?: boolean;
    conptyInheritCursor?: boolean;
}
export interface IPty {
    readonly pid: number;
    readonly cols: number;
    readonly rows: number;
    readonly process: string;
    handleFlowControl: boolean;
    readonly onData: IEvent<Uint8Array>;
    readonly onExit: IEvent<{
        exitCode: number;
        signal?: number;
    }>;
    resize(columns: number, rows: number): void;
    clear(): void;
    write(data: string): void;
    kill(signal?: string): void;
    pause(): void;
    resume(): void;
}
export interface IDisposable {
    dispose(): void;
}
export interface IEvent<T> {
    (listener: (e: T) => any): IDisposable;
}
export type ArgvOrCommandLine = string[] | string;