# cfw-easy-utils

> An utils library for common tasks with CloudFlare Workers.

Latest version **1.0.3** (published 2022-03-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install cfw-easy-utils
pnpm add cfw-easy-utils
yarn add cfw-easy-utils
bun add cfw-easy-utils
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-03-31 |
| First published | 2021-02-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 708.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Cerulean |
| Maintainers | sponsus |
| Keywords | workers, cloudflare, cfw, utils |

## Links

- npm: https://www.npmjs.com/package/cfw-easy-utils
- npm.io page: https://npm.io/package/cfw-easy-utils

## Dependencies (3)

- [cookie](https://npm.io/package/cookie.md) ^0.4.1
- [socket.io](https://npm.io/package/socket.io.md) ^4.0.0
- [nanoevents](https://npm.io/package/nanoevents.md) ^5.1.11

## Alternatives

- [cron](https://npm.io/package/cron.md) — 4.9M weekly downloads
- [@vercel/queue](https://npm.io/package/@vercel/queue.md) — 731.6K weekly downloads
- [create-sonicjs](https://npm.io/package/create-sonicjs.md) — 1.6K weekly downloads
- [@exellix/jobs-api](https://npm.io/package/@exellix/jobs-api.md) — 941 weekly downloads
- [@forwardimpact/libskill](https://npm.io/package/@forwardimpact/libskill.md) — 575 weekly downloads

## Recent versions

- 1.0.3 (latest) — 2022-03-31
- 1.0.2 — 2021-06-25
- 1.0.1 — 2021-06-25
- 0.3.0 — 2021-03-09
- 0.2.5 — 2021-02-28
- 0.2.3 — 2021-02-20
- 0.2.2 — 2021-02-18
- 0.2.1 — 2021-02-18
- 0.2.0 — 2021-02-18
- 0.1.3 — 2021-02-18
- 0.1.2 — 2021-02-12
- 0.1.1 — 2021-02-11
- 0.1.0 — 2021-02-11
- 0.0.2 — 2021-02-11
- 0.0.1 — 2021-02-11

## README

# 🦄 CF Workers: easy-utils
*A library designed to make writing workers so much cleaner and easier!*

Welcome to easy-utils, this library is designed to make writing Workers easy as heck. Included in this package is a bunch of helpers for responses, profiling, handling cookies, and serving any static assets. Now with full Websocket support!

Turn your Worker code from spaghetti hell to majestic artwork today with easy-utils.

**Documentation**:
## https://easy-utils.docs.ceru.dev/docs/

## 🔧 Install
`npm i cfw-easy-utils` 

*Note: this lib has tree-shaking enabled by default. Only import what you need and you will keep your package size low!*

## ✨ Examples

### 🔨 No more JSON.stringify!
Stuck having to copy paste the same 4 lines of code just to return a simple JSON object? Now you can easily return any JSON-compatible object/array without having to worry about your code getting complex.
```js
return response.json({ 'hello': 'world!' })
```

### 🎨 Cache S3 buckets & more!
Want to save money on your bill? Cache your assets on the edge and speed up your images. All of Cloudflare's caching power in a single line of code.
```js
return response.static(request, { baseUrl: 'https://yourbucket.net' })
```

### 🔌 Go realtime with Websockets!
Support Websockets at the edge with our util library. Get access to a full Websocket client and server for your every need.
```js
import { response, Websocket, WebsocketResponse } from 'cfw-easy-utils'

var ws = new Websocket('ws://echo.websocket.org') // Client
var resp = new WebsocketResponse() // Server

ws.on('message', (msg) => {
    resp.send(msg)
})

resp.on('message', (msg) => {
    ws.send(msg)
})

return response.websocket(resp)
```

### 🍃 Handle CORS with a breeze!
CORS can be so cumbersome and annoying. Let easy-utils handle it for you so you can focus on your Worker's real purpose.
```js
if (request.method == 'OPTIONS') {
    return response.cors()
}

// autoCors is true by default, but we want to show it off.
return response.json({ hello: 'World' }, { autoCors: true })
```

### ⏱ Time your I/O to reduce slowdowns.
Record your times to watch for any slow I/O events. Will only count I/O as Workers cannot count CPU time internally. All you need to do is mark some times, then set the Stopwatch option on *any* of easy-utils response handler and it will set the `Server-Timing` header for you. Look in the `Timing` header of your modern browser to view the timings.
```js
import { Stopwatch } from 'cfw-easy-utils'

const watch = new Stopwatch()
const value = await KVNAMESPACE.get('somekey')
watch.mark('Got KV response')
return response.json({ kv: value }, { stopwatch: watch })
```

### 😄 Generate user accounts on the edge
Want to take your user experience to the next level? You can generate password hashes and UUID's direct in your Worker.
```js
import { response, secrets } from 'cfw-easy-utils'

// Later, use secrets.verifyPassword to verify someone's identity.
return response.json({
    id: secrets.uuidv4(),
    passwordHash: await secrets.hashPassword('passw0rd01')
})
```

### 🦄 This is only some of the examples of what you can do with cfw-easy-utils.

Made by Connor Vince with the help and love from the Cloudflare Worker's community. Thank you everyone!

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