Interface: IParser

Allows hooking into the parser for custom handling of escape sequences.

Hierarchy

  • IParser

Index

Methods

Methods

registerCsiHandler

registerCsiHandler(id: IFunctionIdentifier, callback: function): IDisposable

Defined in xterm.d.ts:1331

Adds a handler for CSI escape sequences.

Parameters:

id: IFunctionIdentifier

Specifies the function identifier under which the callback gets registered, e.g. {final: ‘m’} for SGR.

callback: function

The function to handle the sequence. The callback is called with the numerical params. If the sequence has subparams the array will contain subarrays with their numercial values. Return true if the sequence was handled; false if we should try a previous handler (set by addCsiHandler or setCsiHandler). The most recently added handler is tried first.

▸ (params: number number[][]): boolean

Parameters:

Name Type
params number | number[][]

Returns: IDisposable

An IDisposable you can call to remove this handler.


registerDcsHandler

registerDcsHandler(id: IFunctionIdentifier, callback: function): IDisposable

Defined in xterm.d.ts:1350

Adds a handler for DCS escape sequences.

Parameters:

id: IFunctionIdentifier

Specifies the function identifier under which the callback gets registered, e.g. {intermediates: ‘$’ final: ‘q’} for DECRQSS.

callback: function

The function to handle the sequence. Note that the function will only be called once if the sequence finished sucessfully. There is currently no way to intercept smaller data chunks, data chunks will be stored up until the sequence is finished. Since DCS sequences are not limited by the amount of data this might impose a problem for big payloads. Currently xterm.js limits DCS payload to 10 MB which should give enough room for most use cases. The function gets the payload and numerical parameters as arguments. Return true if the sequence was handled; false if we should try a previous handler (set by addDcsHandler or setDcsHandler). The most recently added handler is tried first.

▸ (data: string, param: number number[][]): boolean

Parameters:

Name Type
data string
param number | number[][]

Returns: IDisposable

An IDisposable you can call to remove this handler.


registerEscHandler

registerEscHandler(id: IFunctionIdentifier, handler: function): IDisposable

Defined in xterm.d.ts:1363

Adds a handler for ESC escape sequences.

Parameters:

id: IFunctionIdentifier

Specifies the function identifier under which the callback gets registered, e.g. {intermediates: ‘%’ final: ‘G’} for default charset selection.

handler: function

▸ (): boolean

Returns: IDisposable

An IDisposable you can call to remove this handler.


registerOscHandler

registerOscHandler(ident: number, callback: function): IDisposable

Defined in xterm.d.ts:1381

Adds a handler for OSC escape sequences.

Parameters:

ident: number

The number (first parameter) of the sequence.

callback: function

The function to handle the sequence. Note that the function will only be called once if the sequence finished sucessfully. There is currently no way to intercept smaller data chunks, data chunks will be stored up until the sequence is finished. Since OSC sequences are not limited by the amount of data this might impose a problem for big payloads. Currently xterm.js limits OSC payload to 10 MB which should give enough room for most use cases. The callback is called with OSC data string. Return true if the sequence was handled; false if we should try a previous handler (set by addOscHandler or setOscHandler). The most recently added handler is tried first.

▸ (data: string): boolean

Parameters:

Name Type
data string

Returns: IDisposable

An IDisposable you can call to remove this handler.