website·Indexed 30 days ago
https://flareutils.pages.devA collection of utility classes and functions for Cloudflare Workers, including BetterKV for KV v2 caching, Temra templating engine, Stubby for Durable Object Stub memory storage, PromiseQueue for I/O concurrency management, and the Resizer utility for the Image Resizing API.
env.DO.jurisdiction("eu")) to the Stubby setup function instead of the standard Durable Object Namespace Binding.const stubby = new Stubby(
env.DO.jurisdiction("eu"),
env.KV,
ctx.waitUntil.bind(ctx)
);Phonetic class generates random phonetic strings. It requires a random number generator function that returns a value between 0 and 1. For cryptographic security, it is recommended to use a secure generator like crypto.getRandomValues or the Isaac generator; otherwise, Math.random can be used for non-secure purposes.import { Phonetic } from "flareutils";
// Use Math.random for non-secure needs, or a secure RNG for cryptographic security
const random = Math.random;
const generator = new Phonetic(random);
// Generate a phonetic string with default length
console.log(generator.rand());
// Generate a phonetic string with a specific length (e.g., 10 characters)
console.log(generator.rand(10));PromiseQueue is a utility used to bulk-queue I/O-related promises to avoid hitting concurrency limits (such as those found in Cloudflare Workers).
Crucially, both queue.add and queue.flush return promises and must be awaited. Failing to await queue.add can lead to the queue processing more than 6 promises simultaneously, defeating the purpose of the concurrency limit.
const queue = new PromiseQueue();
for (let i = 0; i < 100; i++) {
await queue.add(env.KV.delete("key" + i));
}
await queue.flush();To use the Resizer utility, you must meet the following infrastructure requirements:
Optional Security and Maintenance:
cf.worker.upstream_zone).KVNamespace standard, but requires specific instantiation parameters. Note that this version is specifically for KV v1.import { BetterKV } from "flareutils";
export default <ExportedHandler>{
async fetch(req, env, ctx) {
// Parameters:
// 1. The KV Namespace from env
// 2. The bound waitUntil function from ctx
// 3. (Optional) A string identifying the Cache Space to avoid collisions between multiple namespaces
const bKv = new BetterKV(env.KV, ctx.waitUntil.bind(ctx), "cachespace");
// ...
},
};The sendMail function from flareutils is a simple fetch wrapper designed to send emails quickly using the MailChannels API.
Important Requirements:
import { sendMail } from "flareutils";
export default <ExportedHandler>{
async fetch(req) {
await sendMail({
from: {
name: "John Foobar",
email: "john@foobar.baz",
},
personalizations: {
to: [
{
name: "Jane Foobar",
email: "jane@foobar.baz",
},
],
subject: "Where do I find that blue shark plushy?",
},
content: [
{
type: "text/plain",
value: "I've been looking for that blue shark plushy for ages, but I can't find it anywhere. Do you know where I can find it?",
},
],
});
// ...
},
};waitUntil function is request-specific, it must be updated for every new request using setWaitUntil.bKv.setWaitUntil(ctx.waitUntil.bind(ctx));Isaac class provides a cryptographically-secure random number generator based on the ISAAC algorithm. It is backed by crypto.getRandomValues and the DRAND network. To instantiate it, provide a seed string (preferably unique or random) and an optional number of times to run the seed through the mixer (defaults to 1).import { Isaac } from "flareutils";
export default <ExportedHandler>{
async fetch(req) {
const isaac = new Isaac("my seed", 2);
// ...
},
};waitUntil function is request-specific, you must update it for every new request using the setWaitUntil method.bKv.setWaitUntil(ctx.waitUntil.bind(ctx));Temra constructor initializes the engine with optional settings to handle tag prefixes and HTML comments. It is recommended to cache the resulting HTML before returning it to the user.import { Temra } from "flareutils";
// Parameters:
// 1. prefix: Default prefix for template tags (e.g., "@" means @name is read as name).
// 2. deleteComments: Boolean. If true, removes all HTML comments before parsing.
const temra = new Temra("@", true);Isaac instance occurs asynchronously. To prevent errors, you should create a single instance at startup and await the seeding property before calling random number methods.if (isaac.seeding) {
await isaac.seeding;
}