- 🎌 Group Error handling
- 🧬 Lifecycle Hooks
- 📍 Concise Signature
- 📦 Zero Dependency
- 🛑 try/catch ~~HELL~ 👹
- 🌟 Better Visibility and Control
- 🌐 Works in ESM & CJS
- 〽️ Minimal Obsessive Disorder
In Lua Errors are detected and explained in terms of Lua. ^Lua:5.4 ^Lua:8.4, ^Lua:8.5
You can contrast that with C, where the behavior of many wrong programs can only be explained in terms of the underling hardware and error positions are given as a program counter
Activities start from a call by the application, usually asking to run a chunk.
If there is any error, this call returns an error code and the application can take appropriate actions
🔹 pcall.js is heavily inspired by Lua pcall with superpowers 🦄!
pcall({f}, {arg1}, {...})
pcall() Calls function {f} with the given arguments in protected mode.
This means that any error inside {f} is not propagated;
Instead, pcall catches the error and returns a tuple.
Its first element is the error code status code (a boolean),
Which is false true
And all results from the call, on second element; [false, {res}]
In case of any error,
Pcall returns true false[true, {err}]
# install
npm install pcall.js// ESM
import Pcall from 'pcall.js'
// CJS
const Pcall = require('pcall.js')import { readFile } from 'node:fs/promises'
// 🔻 BEFORE
try {
const res = await readFile('./package.json', { encoding: 'utf8' })
} catch(error) {
console.error(error, '🔥')
}
// ─────────────────
// 🔹AFTER
import Pcall from 'pcall.js'
const [err, res] = await Pcall(readFile, './package.json', { encoding: 'utf8' })
// 🔸THROW
err && throw new Error("XYZZY", { cause: err });
// ─────────────────
// 🔸 NO @ITERATOR
import Pcall from 'pcall.js'
const pcall = new Pcall({ noError: true })
const res = await pcall(readFile, './package.json', { encoding: 'utf8' })
// ─────────────────
// 🔸 MOCK
const readJson = new Pcall({
fn: readFile,
noError: true,
args: [{ encoding: 'utf8' }],
transformOnSuccess: (args, res) => JSON.parse(res),
transformOnFailure: (args, { name, message }) => ({ name, message }),
})
const path = 'test/sample-good.json'
const res = await readJson(path)
log(res.hogo) // fugaimport { readFile } from 'node:fs/promises'
import Pcall from 'pcall.js'
const pcall = new Pcall({
onSuccess: (args, res) => log({ res, args }, true),
onFailure: (args, err) => log({ err, args }, false),
transformOnSuccess: (args, res) => res,
transformOnFailure: (args, res) => res,
cleanup: () => {},
noError: false,
noTrace: false,
})
const path = './package.json'
const opts = { encoding: 'utf8' }
const [err, res] = await pcall(readFile, path, opts)💡 Check test/ files for more examples
# run test playground in watch mode
npm run dev
# build production
npm run build
# build stub
npm run build:stub- [x] 🌀 Lifecycle Hooks
- [.] 🔌 Serializer
- [.] 🧬 Parser
- [.] 📜 JSDoc
- [.] 🔧 ESLint
- [o] 📖 Docs
- [o]
⚠️ Tests - [.] 💡 Examples