package notty_async

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t
val create : ?dispose:Base.bool -> ?nosig:Base.bool -> ?mouse:Base.bool -> ?bpaste:Base.bool -> ?reader:Async.Reader.t -> ?writer:Async.Writer.t -> Base.unit -> t Async.Deferred.t
val refresh : t -> Base.unit Async.Deferred.t
val image : t -> Notty.image -> Base.unit Async.Deferred.t
val cursor : t -> (Base.int * Base.int) Base.option -> Base.unit Async.Deferred.t
val size : t -> Base.int * Base.int
val release : t -> Base.unit Async.Deferred.t

Release the terminal, restoring it to a state where ordinary I/O can be performed.

val events : t -> [ Notty.Unescape.event | `Resize of Base.int * Base.int ] Async.Pipe.Reader.t

This pipe will automatically be shut down once release is called, and closing this pipe will asynchronous trigger release to be called.

OCaml

Innovation. Community. Security.