Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,42 @@ func main() {
}
}
}

```
Example of getting continuous keystrokes with `GetAllKeys()` function:
```go
package main

import (
"fmt"
"github.com/eiannone/keyboard"
)

func main() {
if err := keyboard.Open(); err != nil {
panic(err)
}

defer func() {
_ = keyboard.Close()
}()

fmt.Println("Press ESC to quit")

keyEvents := keyboard.GetAllKeys() // return's a channel of "KeyEvent"

for ev := range keyEvents {
if ev.Err != nil {
panic(err)
}

fmt.Printf("You pressed: rune %q, key %X\r\n", ev.Rune, ev.Key)

if key == keyboard.KeyEsc {
break
}

}

}
```
23 changes: 23 additions & 0 deletions keyboard_common.go
Original file line number Diff line number Diff line change
Expand Up @@ -229,3 +229,26 @@ func GetSingleKey() (ch rune, key Key, err error) {
}
return
}

func GetAllKeys() <-chan KeyEvent {
keyEventChan := make(chan KeyEvent)

go func(chan<- KeyEvent) {
for {
ke := KeyEvent{}

ke.Rune, ke.Key, ke.Err = GetKey()

if ke.Err != nil {
keyEventChan <- ke
close(keyEventChan)
return
}

keyEventChan <- ke

}
}(keyEventChan)

return keyEventChan
}