https://github.com/seokbeomkim/async-status

A Emacs package to show the status of asynchronous progress.
https://github.com/seokbeomkim/async-status

emacs

Last synced: 7 days ago
JSON representation

A Emacs package to show the status of asynchronous progress.

• Host: GitHub
• URL: https://github.com/seokbeomkim/async-status
• Owner: seokbeomKim
• License: gpl-3.0
• Created: 2023-08-14T07:12:00.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-21T04:20:49.000Z (over 1 year ago)
• Last Synced: 2025-01-28T20:07:42.571Z (14 days ago)
• Topics: emacs
• Language: Emacs Lisp
• Homepage:
• Size: 396 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# async-status

A Emacs package to show the status of asynchronous progress.

![async-status-usage](https://github.com/seokbeomKim/async-status/blob/images/async-status.gif "async-status usage")

## Installation

```

(require 'async-status)

```

## What is this package?

This package supports status bar to show the progress of asynchronous process.

Even though Emacs does not support threads, some packages similar to 'async' are

invoking Emacs process for the same purpose, but we need to wait without knowing

the progress. By using this package, packages using 'async' can notify the users

to know the working progress.

## Usage

Please refer 'async-status-test.el'. By evaluating the file, you can see the

result.

### APIs for parent process

- `async-status-req-id` creates the file to interact with the child process.

- `async-status-add-item-to-bar` registers the corresponding item to the

  indicator.

- `async-status-remove-item-from-bar` removes the corresponding item from the

  indicator.

- `async-status-show` displays the indicator.

- `async-status-hide` hides the indicator unless there are no registered items.

- `async-status-clean-up` and clean the corresponding file nodes.

### APIs for child process

- `async-status-safely-set-msg-val` writes the value to corresponding file node.

## Feedback

If you have any feedback, suggestions for improvements or advice, please feel

free to get in touch.