fix some docs

This commit is contained in:
Jörg Breitbart
2018-05-07 23:28:40 +02:00
parent a37449a8cd
commit 02893dcbb8
3 changed files with 14 additions and 7 deletions
+7 -2
View File
@@ -454,8 +454,13 @@ export interface IParsingState {
* EscapeSequenceParser handles DCS commands via separate
* subparsers that get hook/unhooked and can handle
* arbitrary amount of print data.
* NOTE: EscapeSequenceParser might call `put` several times,
* therefore you have to collect `data` until unhook is called.
* On entering a DSC sequence `hook` is called by
* `EscapeSequenceParser`. Use it to initialize or reset
* states needed to handle the current DCS sequence.
* EscapeSequenceParser will call `put` several times if the
* parsed string got splitted, therefore you might have to collect
* `data` until `unhook` is called. `unhook` marks the end
* of the current DCS sequence.
*/
export interface IDcsHandler {
hook(collect: string, params: number[], flag: number): void;