From 2aa9d6cbdba0fe9cbc5d72dd24b07475d5901b8e Mon Sep 17 00:00:00 2001 From: Moses <50459836+justanothermoses@users.noreply.github.com> Date: Thu, 2 Oct 2025 11:56:29 +0200 Subject: [PATCH] fix(NOSS-1): readme update (#37) * chore: export PayloadAssistError * fix(noss-1): fix readme setup example, links and remove link underline * chore: Fix no underline on npm link * Update README.md --------- Co-authored-by: Moses Co-authored-by: conny. <36863945+ConnysCode@users.noreply.github.com> --- README.md | 52 +++++++++++++++++++++++----------------------------- src/index.ts | 2 ++ 2 files changed, 25 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index e9298b1..54162cd 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,9 @@ Assist for Payload
- - - - - Assist for Payload - - - - - - Tests passing - - - - - License MIT - +Assist for Payload + Tests passing + License MIT
# Assist for Payload @@ -91,18 +77,27 @@ payloadAssist is implemenented as a wrapper function and not as a payload plugin ```ts import { buildConfig } from "payload"; -import payloadAssist, { defaultConfig } from "@byte5digital/payload-assist"; - -export default payloadAssist({ - // your Payload config -}, { - ruleSet: { - ...defaultConfig.ruleSet, +import payloadAssist, { + defaultConfig, + PayloadAssistError, +} from "@byte5digital/payload-assist"; - // add/override rules here - secretIsSet: (config) => config.secret?.length > 0 ? true : throw 'A secret needs to be set', +export default payloadAssist( + { + // your Payload config }, -}); + { + ruleSet: { + ...defaultConfig.ruleSet, + + // add/override rules here + secretIsSet: (config) => { + if (config.secret?.length > 0) return true; + throw new PayloadAssistError("A secret needs to be set"); + }, + }, + } +); ``` --- @@ -236,8 +231,7 @@ If you love building smart solutions with real impact — we should talk. ## Support -- [Issue Tracker](https://github.com/byte5digital/meilisearch-pro/issues) -- [Discord Community](https://discord.gg/medusajs) +- [Issue Tracker](https://github.com/byte5digital/payload-assist/issues) - [Email Support](mailto:support@byte5.de) --- diff --git a/src/index.ts b/src/index.ts index 293ee39..29aff9f 100644 --- a/src/index.ts +++ b/src/index.ts @@ -14,3 +14,5 @@ export { Expose, Type } from "class-transformer"; export type { PayloadAssistConfig, PayloadAssistOptions } from "./types/config"; export type { RuleSet } from "./types/rule-set"; export type { AccessControl } from "./types/access-control"; + +export { default as PayloadAssistError } from "./types/PayloadAssistError";