1.1.5 ā€¢ Published 1 year ago

extra-asciinema.web v1.1.5

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

asciinema is a terminal screen recorder. šŸ“¦ Node.js, šŸŒ Web, šŸ“œ Files, šŸ“° Docs. šŸ“˜ Wiki.

With this package you can auto-generate terminal recordings for Node.js examples through asciinema programmatically. But you need to install asciinema first!

This package is available in Node.js and Web formats (for retimeData()). The web format is exposed as extra_asciinema standalone variable and can be loaded from jsDelivr CDN.

Stability: Experimental.

const asciinema = require('extra-asciinema');
// import * as asciinema from 'extra-asciinema';

asciinema.recSync('saved.cast', {input: 'example.js'});
// runs example.js interactively in node.js, saves 'saved.cast'

asciinema.retimeSync('saved.cast', {inputDelay: 2});
// 'saved.cast' is updated

asciinema.uploadSync('saved.cast');
// asciicast URL

Index

PropertyDescription
recRecord terminal session.
recSyncRecord terminal session.
catPrint full output of recorded asciicast to a terminal.
catSyncPrint full output of recorded asciicast to a terminal.
retimeUpdate time in asciicast file.
retimeDataUpdate time in asciicast data.
retimeSyncUpdate time in asciicast file.
uploadUpload recorded asciicast to asciinema.org site.
uploadSyncUpload recorded asciicast to asciinema.org site.

References

npm.io ORG