Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SerialPort

Hierarchy

  • BaseRPCAdapter
    • SerialPort

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

baudRate

  • get baudRate(): number

  • Returns number

binding

  • get binding(): null

  • Returns null

closing

  • get closing(): boolean

  • Returns boolean

isOpen

  • get isOpen(): boolean

  • Returns boolean

opening

  • get opening(): boolean

  • Returns boolean

path

  • get path(): string

  • Returns string

Protected rpcReady

  • get rpcReady(): Promise<boolean>

  • Returns Promise<boolean>

Static getRpcClient

  • get getRpcClient(): () => Promise<RpcClient>
  • set getRpcClient(getRpcClient: () => Promise<RpcClient>): void

  • Returns () => Promise<RpcClient>

  • Parameters

    Returns void

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): SerialPort

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SerialPort

baseDestroy

  • baseDestroy(): void

  • Returns void

checkSocketReady

  • checkSocketReady(reject?: (err: Error) => void): void

  • Parameters

    • Optional reject: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

close

  • Parameters

    Returns void

destroy

  • destroy(): void

  • Returns void

drain

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

flush

get

getMaxListeners

  • getMaxListeners(): number

  • Returns number

initRpc

  • Returns Promise<RpcClient>

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): SerialPort

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SerialPort

on

  • on(event: string | symbol, listener: (...args: any[]) => void): SerialPort

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SerialPort

once

  • once(event: string | symbol, listener: (...args: any[]) => void): SerialPort

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SerialPort

open

pause

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): SerialPort

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SerialPort

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): SerialPort

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SerialPort

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

read

  • read(): null | string | Buffer

  • 该方法目前还没办法实现，node 的库是以 stream 的形式实现同步的 TODO: 实现 read 方法

    Returns null | string | Buffer

removeAllListeners

  • removeAllListeners(event?: string | symbol): SerialPort

  • Parameters

    • Optional event: string | symbol

    Returns SerialPort

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): SerialPort

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SerialPort

resume

Protected rpcCall

  • rpcCall(method: string, params?: any[], timeout?: number): Promise<any>

  • Parameters

    • method: string
    • Optional params: any[]
    • Optional timeout: number

    Returns Promise<any>

rpcCloseHandler

  • rpcCloseHandler(): void

  • Returns void

Protected rpcListen

  • rpcListen(eventName: string, listener: (...args: any[]) => void): Promise<void>

  • Parameters

    • eventName: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Promise<void>

Protected rpcSubcribe

  • rpcSubcribe(eventName: string): Promise<void>

  • Parameters

    • eventName: string

    Returns Promise<void>

Protected rpcUnsubcribe

  • rpcUnsubcribe(eventName: string): Promise<void>

  • Parameters

    • eventName: string

    Returns Promise<void>

set

setMaxListeners

  • Parameters

    • n: number

    Returns SerialPort

update

write

Static createError

  • createError(code: number, msg: string): UCodeLinkAPIError

  • Parameters

    • code: number
    • msg: string

    Returns UCodeLinkAPIError

Static getEventListener

  • getEventListener(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: EventEmitter | DOMEventTarget
    • name: string | symbol

    Returns Function[]

Static list

  • list(filterOpened?: boolean): Promise<PortInfo[]>

  • Parameters

    • filterOpened: boolean = true

    Returns Promise<PortInfo[]>

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc