Skip to content

Commit

Permalink
Externalize solid-js dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
Exelord committed Jan 21, 2023
1 parent 0129600 commit 8e2417d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,26 @@
</p>

# Solid Tasks

Solid Tasks is a package for managing and controlling async operations in solid-js applications. It provides a simple API for controlling the execution of promises and their cancellation. With Solid Tasks, it is easy to build robust and performant solid-js applications, especially when it comes to handling data fetching, events, and user interactions.

## Installation

To install Solid Tasks can use npm:

```sh
npm install solid-tasks
```

## Requirements

- Solid.js v1.0.0 or higher
- Environment that supports [AbortController API](https://developer.mozilla.org/en-US/docs/Web/API/AbortController)

## What are solid-tasks?

It is a plugin for solid-js that allows you to manage async operations in your application. It provides a way to perform and cancel async operations, and observe their state. solid-tasks uses jobs to coordinate async operations. By creating a job and performing it, you can execute a task and handle its cancellation and coordination. Jobs can be created in different modes that allows to handle different use cases such as button clicks, data loading, live search fields or long-polling.

## Jobs

A job is a way to coordinate async operations in your application. It provides a way to perform and cancel async operations, and observe their state. With solid-tasks, you can create jobs that allow you to handle cancellation and coordination of async operations. For example, you can use a job to handle a button click and prevent unexpected events from clicking it multiple times.
2 changes: 1 addition & 1 deletion vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default defineConfig({
formats: ["cjs", "es"],
},
rollupOptions: {
external: ["solid-proxies"],
external: ["solid-proxies", "solid-js"],
},
},
resolve: {
Expand Down

0 comments on commit 8e2417d

Please sign in to comment.