@types/serialport/index.d.ts

/// <reference types="node" />

import * as Stream from "stream";

declare class SerialPort extends Stream.Duplex {
    constructor(path: string, callback?: SerialPort.ErrorCallback);
    constructor(path: string, options?: SerialPort.OpenOptions, callback?: SerialPort.ErrorCallback);

    readonly baudRate: number;
    readonly binding: SerialPort.BaseBinding;
    readonly isOpen: boolean;
    readonly path: string;

    open(callback?: SerialPort.ErrorCallback): void;
    update(options: SerialPort.UpdateOptions, callback?: SerialPort.ErrorCallback): void;

    write(
        data: string | number[] | Buffer,
        callback?: (error: Error | null | undefined, bytesWritten: number) => void,
    ): boolean;
    write(
        buffer: string | number[] | Buffer,
        encoding?: "ascii" | "utf8" | "utf16le" | "ucs2" | "base64" | "binary" | "hex",
        callback?: (error: Error | null | undefined, bytesWritten: number) => void,
    ): boolean;

    read(size?: number): string | Buffer | null;

    close(callback?: (error?: Error | null) => void): void;

    set(options: SerialPort.SetOptions, callback?: SerialPort.ErrorCallback): void;
    get(callback?: SerialPort.ModemBitsCallback): void;

    flush(callback?: SerialPort.ErrorCallback): void;
    drain(callback?: SerialPort.ErrorCallback): void;

    pause(): this;
    resume(): this;

    on(event: string, callback: (data?: any) => void): this;

    static Binding: SerialPort.BaseBinding;

    static list(): Promise<SerialPort.PortInfo[]>;
}

declare namespace SerialPort {
    // Callbacks Type Defs
    type ErrorCallback = (error?: Error | null) => void;
    type ModemBitsCallback = (
        error: Error | null | undefined,
        status: { cts: boolean; dsr: boolean; dcd: boolean },
    ) => void;

    // Options Type Defs
    interface OpenOptions {
        autoOpen?: boolean | undefined;
        baudRate?:
            | 115200
            | 57600
            | 38400
            | 19200
            | 9600
            | 4800
            | 2400
            | 1800
            | 1200
            | 600
            | 300
            | 200
            | 150
            | 134
            | 110
            | 75
            | 50
            | number
            | undefined;
        dataBits?: 8 | 7 | 6 | 5 | undefined;
        highWaterMark?: number | undefined;
        lock?: boolean | undefined;
        stopBits?: 1 | 2 | undefined;
        parity?: "none" | "even" | "mark" | "odd" | "space" | undefined;
        rtscts?: boolean | undefined;
        xon?: boolean | undefined;
        xoff?: boolean | undefined;
        xany?: boolean | undefined;
        binding?: BaseBinding | undefined;
        bindingOptions?: {
            vmin?: number | undefined;
            vtime?: number | undefined;
        } | undefined;
    }
    interface UpdateOptions {
        baudRate?:
            | 115200
            | 57600
            | 38400
            | 19200
            | 9600
            | 4800
            | 2400
            | 1800
            | 1200
            | 600
            | 300
            | 200
            | 150
            | 134
            | 110
            | 75
            | 50
            | number
            | undefined;
    }
    interface SetOptions {
        brk?: boolean | undefined;
        cts?: boolean | undefined;
        dsr?: boolean | undefined;
        dtr?: boolean | undefined;
        rts?: boolean | undefined;
    }

    interface PortInfo {
        path: string;
        manufacturer?: string | undefined;
        serialNumber?: string | undefined;
        pnpId?: string | undefined;
        locationId?: string | undefined;
        productId?: string | undefined;
        vendorId?: string | undefined;
    }

    namespace parsers {
        class ByteLength extends Stream.Transform {
            constructor(options: { length: number });
        }
        class CCTalk extends Stream.Transform {
            constructor();
        }
        class Delimiter extends Stream.Transform {
            constructor(options: { delimiter: string | Buffer | number[]; includeDelimiter?: boolean | undefined });
        }
        class Readline extends Delimiter {
            constructor(
                options: {
                    delimiter: string | Buffer | number[];
                    encoding?: "ascii" | "utf8" | "utf16le" | "ucs2" | "base64" | "binary" | "hex" | undefined;
                    includeDelimiter?: boolean | undefined;
                },
            );
        }
        class Ready extends Stream.Transform {
            constructor(options: { delimiter: string | Buffer | number[] });
        }
        class Regex extends Stream.Transform {
            constructor(options: { regex: RegExp });
        }
    }

    // Binding Type Defs
    type win32Binding = BaseBinding;
    type darwinBinding = BaseBinding;
    type linuxBinding = BaseBinding;

    // Binding Type Def
    class BaseBinding {
        constructor(options: any);

        open(path: string, options: OpenOptions): Promise<any>;
        close(): Promise<any>;

        read(data: Buffer, offset: number, length: number): Promise<any>;
        write(data: Buffer): Promise<any>;
        update(options?: UpdateOptions): Promise<any>;
        set(options?: SetOptions): Promise<any>;
        get(): Promise<any>;
        flush(): Promise<any>;
        drain(): Promise<any>;
        static list(): Promise<PortInfo[]>;
    }
}

export = SerialPort;