# luau-task

> A Luau task library

Latest version **1.0.1** (published 2024-09-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install luau-task
pnpm add luau-task
yarn add luau-task
bun add luau-task
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2024-09-25 |
| First published | 2024-09-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | jeparlefrancais <jeparlefrancais21@gmail.com> |
| Maintainers | jeparlefrancais |
| Keywords | luau, task, roblox |

## Links

- npm: https://www.npmjs.com/package/luau-task
- Repository: https://github.com/seaofvoices/luau-task
- Homepage: https://github.com/seaofvoices/luau-task#readme
- npm.io page: https://npm.io/package/luau-task

## Recent versions

- 1.0.1 (latest) — 2024-09-25
- 1.0.0 — 2024-09-22

## README

[![checks](https://github.com/seaofvoices/luau-task/actions/workflows/test.yml/badge.svg)](https://github.com/seaofvoices/luau-task/actions/workflows/test.yml)
![version](https://img.shields.io/github/package-json/v/seaofvoices/luau-task)
[![GitHub top language](https://img.shields.io/github/languages/top/seaofvoices/luau-task)](https://github.com/luau-lang/luau)
![license](https://img.shields.io/npm/l/luau-task)
![npm](https://img.shields.io/npm/dt/luau-task)

# luau-task

A tiny package to standardize the Roblox [task library](https://create.roblox.com/docs/reference/engine/libraries/task). It follows the [Sea of Voices Luau Package Standard](https://github.com/seaofvoices/luau-package-standard).

- If `_G.LUA_ENV` is set to `"roblox"`, it will use Roblox `task` global variable.
- If `_G.LUA_ENV` is set to `"lune"`, it will use the [Lune](https://github.com/lune-org/lune) built-in [task package](https://lune-org.github.io/docs/api-reference/task).

_No Luau-only implementation is currently available._

## Installation

Add `luau-task` in your dependencies:

```bash
yarn add luau-task
```

Or if you are using `npm`:

```bash
npm install luau-task
```

## Other Lua Environments Support

If you would like to use this library on a Lua (or Luau) environment where it is currently incompatible, open an issue (or comment on an existing one) to request the appropriate modifications.

The library uses [darklua](https://github.com/seaofvoices/darklua) to process its code.

## License

This project is available under the MIT license. See [LICENSE.txt](LICENSE.txt) for details.

---
_Source: https://npm.io/package/luau-task · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._