@e280/stz 0.0.0-31 → 0.0.0-33

package/README.md

@@ -10,7 +10,6 @@ zero dependencies.
 <br/>
 
 ## 🧰 STZ PRIMITIVES
-> cool concepts we use all over the place
 
 ### 🍏 MapG
 > extended js map
@@ -35,7 +34,7 @@ const map = new MapG<number, string>([
     // "rofl"
   ```
 
-### nap
+### 🍏 nap
 > sleep for some milliseconds
 
 ```ts
@@ -45,7 +44,7 @@ await nap(900)
   // wait for 900 milliseconds
 ```
 
-### defer
+### 🍏 defer
 > defer the resolve/reject of a promise to the outside
 
 ```ts
@@ -123,7 +122,6 @@ import {pub, sub} from "@e280/stz"
 <br/>
 
 ## 🧰 FN TOOLS
-> function-oriented tools
 
 ### 🍏 `queue(fn)`
 > execute calls in sequence (not concurrent)
@@ -155,20 +153,40 @@ fn()
 console.log(count) // 1
 ```
 
-### 🍏 `deadline(100, message, fn)`
+### 🍏 `deadline(100, fn)`
 > throws an error if the async function takes too long
 
 ```ts
 import {deadline} from "@e280/stz"
 
-const fn = deadline(100, "deadline exceeded", async() => {
+const fn = deadline(100, async() => {
 
   // example deliberately takes too long
   await nap(200)
 })
 
 await fn()
-  // DeadlineError: deadline exceeded, timed out in 0.1 seconds
+  // DeadlineError: deadline exceeded (0.1 seconds)
+```
+
+### 🍏 `debounce(100, fn)`
+> wait some time before actually executing the fn (absorbing redundant calls)
+
+we use `debounce` a lot in ui code, like on a user's keyboard input in a form field, but rendering the form input can actually be slow enough that it causes problems when they type fast — to eliminate the jank, we `debounce` with like 400 ms, so we wait for the user to finish typing for a moment before actually running the validation.
+
+```ts
+import {debounce} from "@e280/stz"
+
+const fn = debounce(100, async() => {
+  await coolSlowActionOrWhatever()
+})
+
+// each fn() call resets the timer
+fn()
+fn()
+fn()
+
+// coolSlowActionOrWhatever, the others are redundant
 ```
 
 ### 🍏 `repeat(fn)`
@@ -194,10 +212,43 @@ stop()
 <br/>
 
 ## 🧰 DATA UTILITIES
-> transforming and representing binary data
+
+### 🍏 Hex
+> convert to/from hexadecimal string format
+- `Hex.fromBytes(bytes)` — bytes to hex string
+- `Hex.toBytes(string)` — hex string to bytes
+- `Hex.random(32)` — generate random hex string (32 bytes)
+
+### 🍏 Base64
+> convert to/from base64 string format
+- `Base64.fromBytes(bytes)` — bytes to string
+- `Base64.toBytes(string)` — string to bytes
+- `Base64.random(32)` — generate random string (32 bytes)
+
+### 🍏 Base64url
+> convert to/from base64 string format
+- `Base64url.fromBytes(bytes)` — bytes to string
+- `Base64url.toBytes(string)` — string to bytes
+- `Base64url.random(32)` — generate random string (32 bytes)
+
+### 🍏 Base58
+> convert to/from base64 string format
+- `Base58.fromBytes(bytes)` — bytes to string
+- `Base58.toBytes(string)` — string to bytes
+- `Base58.random(32)` — generate random string (32 bytes)
+
+### 🍏 Txt
+> convert to/from utf8 string format
+- `Txt.fromBytes(bytes)` — bytes to string
+- `Txt.toBytes(string)` — string to bytes
+
+### 🍏 Bytes
+> utilities for dealing with Uint8Array
+- `Bytes.eq(bytesA, bytesB)` — check if two byte arrays are equal
+- `Bytes.random(32)` — generate crypto-random bytes
 
 ### 🍏 BaseX
-> represent data in arbitrary encodings
+> convert data into arbitrary data encodings
 - make a BaseX instance
   ```ts
   import {BaseX} from "@e280/stz"

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@e280/stz",
-	"version": "0.0.0-31",
+	"version": "0.0.0-33",
 	"description": "everyday ts fns for everything",
 	"license": "MIT",
 	"author": "Chase Moskal <chasemoskal@gmail.com>",