[{"data":1,"prerenderedAt":1900},["ShallowReactive",2],{"navLinks":3,"sidebar_docs_navigation_\u002Fdocs\u002Futils":64,"navigation":263,"navLinks_footer":835,"\u002Fdocs\u002Futils\u002Fserver\u002Frun_page":848,"\u002Fdocs\u002Futils\u002Fserver\u002Frun_surround":1459,"\u002Fdocs\u002Futils\u002Fserver\u002Frun":1462},{"id":4,"extension":5,"links":6,"meta":61,"stem":62,"__hash__":63},"navigationMenu\u002Fnavigation.json","json",[7,52,57],{"nested":8,"label":9,"icon":10,"to":11,"children":12},true,"Docs","i-lucide-book-open","\u002Fdocs\u002Fgetting-started",[13,19,26,32,39,45],{"label":14,"icon":15,"to":11,"description":16,"github":17,"badge":18},"Getting Started","i-lucide-rocket","An introduction to help you understand the core components.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Fdocshub","Start Here",{"label":20,"icon":21,"to":22,"description":23,"github":24,"badge":25},"Auth H3 Client","i-lucide-key-round","\u002Fdocs\u002Fauth-h3client","Seamlessly enforce OAuth 2.0 authentication and session management integrated directly as the client of the IAM module.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Fauth-h3client","Core",{"label":27,"icon":28,"to":29,"description":30,"github":31,"badge":25},"IAM","i-lucide-shield-check","\u002Fdocs\u002Fiam","Identity and Access Management featuring granular roles, permissions, and security policies.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Fauth",{"label":33,"icon":34,"to":35,"description":36,"github":37,"badge":38},"Bot Detection","i-lucide-cpu","\u002Fdocs\u002Fbot-detection","Advanced behavioral analysis and request fingerprinting to stop malicious automated traffic.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Fbot-detector","Security",{"label":40,"icon":41,"to":42,"description":43,"github":44,"badge":38},"Shield Base","i-lucide-database-zap","\u002Fdocs\u002Fshield-base","CLI and programmatic toolkit for compiling offline-ready IP intelligence databases from BGP, GeoIP, Tor, FireHOL, and other public threat feeds.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Fshield-base-cli",{"label":46,"icon":47,"to":48,"description":49,"github":50,"badge":51},"Utils","i-lucide-wrench","\u002Fdocs\u002Futils","A standard library of highly optimized helpers for formatting, validation, and core logic.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Futils","Library",{"nested":53,"label":54,"icon":55,"to":56},false,"Blog","i-lucide-pen-line","\u002Fblog",{"nested":53,"label":58,"icon":59,"to":60},"Website","lucide:app-window-mac","https:\u002F\u002Friavzon.com",{},"navigation","gkaQ0xRGxSLrLyM3kttLe0oBwkrR1EBjlepF8LSbwF8",[65],{"title":9,"path":66,"stem":67,"children":68,"page":53},"\u002Fdocs","docs",[69],{"title":70,"path":48,"stem":71,"children":72},"Utilities","docs\u002Futils\u002Findex",[73,74,91,124,221],{"title":70,"path":48,"stem":71},{"title":75,"path":76,"stem":77,"children":78,"page":53},"Eslint","\u002Fdocs\u002Futils\u002Feslint","docs\u002Futils\u002Feslint",[79,83,87],{"title":80,"path":81,"stem":82},"React Config","\u002Fdocs\u002Futils\u002Feslint\u002Freact","docs\u002Futils\u002Feslint\u002Freact",{"title":84,"path":85,"stem":86},"TypeScript Config","\u002Fdocs\u002Futils\u002Feslint\u002Ftypescript","docs\u002Futils\u002Feslint\u002Ftypescript",{"title":88,"path":89,"stem":90},"Vue Config","\u002Fdocs\u002Futils\u002Feslint\u002Fvue","docs\u002Futils\u002Feslint\u002Fvue",{"title":92,"path":93,"stem":94,"children":95,"page":53},"Server","\u002Fdocs\u002Futils\u002Fserver","docs\u002Futils\u002Fserver",[96,100,104,108,112,116,120],{"title":97,"path":98,"stem":99},"Encryption","\u002Fdocs\u002Futils\u002Fserver\u002Fencryption","docs\u002Futils\u002Fserver\u002Fencryption",{"title":101,"path":102,"stem":103},"Path Resolver","\u002Fdocs\u002Futils\u002Fserver\u002Fpathresolver","docs\u002Futils\u002Fserver\u002FpathResolver",{"title":105,"path":106,"stem":107},"File Replacements","\u002Fdocs\u002Futils\u002Fserver\u002Freplace","docs\u002Futils\u002Fserver\u002Freplace",{"title":109,"path":110,"stem":111},"run","\u002Fdocs\u002Futils\u002Fserver\u002Frun","docs\u002Futils\u002Fserver\u002Frun",{"title":113,"path":114,"stem":115},"scheduleTask","\u002Fdocs\u002Futils\u002Fserver\u002Fscheduletask","docs\u002Futils\u002Fserver\u002FscheduleTask",{"title":117,"path":118,"stem":119},"spawnRun","\u002Fdocs\u002Futils\u002Fserver\u002Fspawnrun","docs\u002Futils\u002Fserver\u002FspawnRun",{"title":121,"path":122,"stem":123},"uploadCsv","\u002Fdocs\u002Futils\u002Fserver\u002Fuploadcsv","docs\u002Futils\u002Fserver\u002FuploadCsv",{"title":125,"path":126,"stem":127,"children":128,"page":53},"Shared","\u002Fdocs\u002Futils\u002Fshared","docs\u002Futils\u002Fshared",[129,133,137,141,145,149,153,157,161,165,169,173,177,181,185,189,193,197,201,205,209,213,217],{"title":130,"path":131,"stem":132},"BatchQueue","\u002Fdocs\u002Futils\u002Fshared\u002Fbatchqueue","docs\u002Futils\u002Fshared\u002FbatchQueue",{"title":134,"path":135,"stem":136},"capitalize","\u002Fdocs\u002Futils\u002Fshared\u002Fcapitalize","docs\u002Futils\u002Fshared\u002Fcapitalize",{"title":138,"path":139,"stem":140},"chunkProcess","\u002Fdocs\u002Futils\u002Fshared\u002Fchunkprocess","docs\u002Futils\u002Fshared\u002FchunkProcess",{"title":142,"path":143,"stem":144},"cleanObject","\u002Fdocs\u002Futils\u002Fshared\u002Fcleanobject","docs\u002Futils\u002Fshared\u002FcleanObject",{"title":146,"path":147,"stem":148},"createConfigManager","\u002Fdocs\u002Futils\u002Fshared\u002Fconfigurationdefiner","docs\u002Futils\u002Fshared\u002FconfigurationDefiner",{"title":150,"path":151,"stem":152},"debounce","\u002Fdocs\u002Futils\u002Fshared\u002Fdebounce","docs\u002Futils\u002Fshared\u002Fdebounce",{"title":154,"path":155,"stem":156},"ensureArray","\u002Fdocs\u002Futils\u002Fshared\u002Fensurearray","docs\u002Futils\u002Fshared\u002FensureArray",{"title":158,"path":159,"stem":160},"fetchWithRetry","\u002Fdocs\u002Futils\u002Fshared\u002Ffetchwithretry","docs\u002Futils\u002Fshared\u002FfetchWithRetry",{"title":162,"path":163,"stem":164},"filterEmptyValues","\u002Fdocs\u002Futils\u002Fshared\u002Ffilteremptyvalues","docs\u002Futils\u002Fshared\u002FfilterEmptyValues",{"title":166,"path":167,"stem":168},"findStringsInObject","\u002Fdocs\u002Futils\u002Fshared\u002Ffindobjectvalues","docs\u002Futils\u002Fshared\u002FfindObjectValues",{"title":170,"path":171,"stem":172},"fisherYatesShuffle","\u002Fdocs\u002Futils\u002Fshared\u002Ffisheryatesshuffle","docs\u002Futils\u002Fshared\u002FfisherYatesShuffle",{"title":174,"path":175,"stem":176},"getRandomImage","\u002Fdocs\u002Futils\u002Fshared\u002Fgetrandomimage","docs\u002Futils\u002Fshared\u002FgetRandomImage",{"title":178,"path":179,"stem":180},"isObjectHasValues","\u002Fdocs\u002Futils\u002Fshared\u002Fisobjecthasvalues","docs\u002Futils\u002Fshared\u002FisObjectHasValues",{"title":182,"path":183,"stem":184},"isAsyncOrPromise","\u002Fdocs\u002Futils\u002Fshared\u002Fispromise","docs\u002Futils\u002Fshared\u002FisPromise",{"title":186,"path":187,"stem":188},"MiniCache","\u002Fdocs\u002Futils\u002Fshared\u002Fminicache","docs\u002Futils\u002Fshared\u002FminiCache",{"title":190,"path":191,"stem":192},"parseCookies","\u002Fdocs\u002Futils\u002Fshared\u002Fparserawcookies","docs\u002Futils\u002Fshared\u002FparseRawCookies",{"title":194,"path":195,"stem":196},"safeAction","\u002Fdocs\u002Futils\u002Fshared\u002Fpromiselocker","docs\u002Futils\u002Fshared\u002FpromiseLocker",{"title":198,"path":199,"stem":200},"Random","\u002Fdocs\u002Futils\u002Fshared\u002Frandom","docs\u002Futils\u002Fshared\u002Frandom",{"title":202,"path":203,"stem":204},"range","\u002Fdocs\u002Futils\u002Fshared\u002Frange","docs\u002Futils\u002Fshared\u002Frange",{"title":206,"path":207,"stem":208},"rateLimiters","\u002Fdocs\u002Futils\u002Fshared\u002Fratelimiters","docs\u002Futils\u002Fshared\u002FrateLimiters",{"title":210,"path":211,"stem":212},"safeObjectMerge","\u002Fdocs\u002Futils\u002Fshared\u002Fsafemerge","docs\u002Futils\u002Fshared\u002FsafeMerge",{"title":214,"path":215,"stem":216},"textTruncation","\u002Fdocs\u002Futils\u002Fshared\u002Ftexttruncation","docs\u002Futils\u002Fshared\u002FtextTruncation",{"title":218,"path":219,"stem":220},"validateZodSchema","\u002Fdocs\u002Futils\u002Fshared\u002Fvalidatezodschema","docs\u002Futils\u002Fshared\u002FvalidateZodSchema",{"title":222,"path":223,"stem":224,"children":225},"Utility Types","\u002Fdocs\u002Futils\u002Ftypes","docs\u002Futils\u002Ftypes\u002Findex",[226,227,231,235,239,243,247,251,255,259],{"title":222,"path":223,"stem":224},{"title":228,"path":229,"stem":230},"Brand","\u002Fdocs\u002Futils\u002Ftypes\u002Fbrand","docs\u002Futils\u002Ftypes\u002FBrand",{"title":232,"path":233,"stem":234},"DeepPartial","\u002Fdocs\u002Futils\u002Ftypes\u002Fdeeppartial","docs\u002Futils\u002Ftypes\u002FDeepPartial",{"title":236,"path":237,"stem":238},"Merge","\u002Fdocs\u002Futils\u002Ftypes\u002Fmerge","docs\u002Futils\u002Ftypes\u002FMerge",{"title":240,"path":241,"stem":242},"NonNullable","\u002Fdocs\u002Futils\u002Ftypes\u002Fnonnullable","docs\u002Futils\u002Ftypes\u002FNonNullable",{"title":244,"path":245,"stem":246},"Prettify","\u002Fdocs\u002Futils\u002Ftypes\u002Fprettify","docs\u002Futils\u002Ftypes\u002FPrettify",{"title":248,"path":249,"stem":250},"PromiseType","\u002Fdocs\u002Futils\u002Ftypes\u002Fpromisetype","docs\u002Futils\u002Ftypes\u002FPromiseType",{"title":252,"path":253,"stem":254},"RequireKeys","\u002Fdocs\u002Futils\u002Ftypes\u002Frequirekeys","docs\u002Futils\u002Ftypes\u002FRequireKeys",{"title":256,"path":257,"stem":258},"StandardResponse","\u002Fdocs\u002Futils\u002Ftypes\u002Fstandardresponse","docs\u002Futils\u002Ftypes\u002FStandardResponse",{"title":260,"path":261,"stem":262},"ValueOf","\u002Fdocs\u002Futils\u002Ftypes\u002Fvalueof","docs\u002Futils\u002Ftypes\u002FValueOf",[264],{"title":9,"path":66,"stem":67,"children":265,"page":53},[266,413,531,536,714,781],{"title":20,"path":22,"stem":267,"children":268},"docs\u002Fauth-h3client\u002Findex",[269,270,279,316,342,364,367,388,392],{"title":20,"path":22,"stem":267},{"title":14,"path":271,"stem":272,"children":273},"\u002Fdocs\u002Fauth-h3client\u002Fgetting-started","docs\u002Fauth-h3client\u002F00.getting-started\u002Findex",[274,275],{"title":14,"path":271,"stem":272},{"title":276,"path":277,"stem":278},"Nuxt Module","\u002Fdocs\u002Fauth-h3client\u002Fgetting-started\u002Fnuxt","docs\u002Fauth-h3client\u002F00.getting-started\u002F00.nuxt",{"title":280,"path":281,"stem":282,"children":283},"Essentials","\u002Fdocs\u002Fauth-h3client\u002Fessentials","docs\u002Fauth-h3client\u002F01.essentials\u002Findex",[284,285,289,293,297,301,305,308,312],{"title":280,"path":281,"stem":282},{"title":286,"path":287,"stem":288},"Session Management","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Fsession","docs\u002Fauth-h3client\u002F01.essentials\u002F00.session",{"title":290,"path":291,"stem":292},"Route Protection","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Froute-protection","docs\u002Fauth-h3client\u002F01.essentials\u002F01.route-protection",{"title":294,"path":295,"stem":296},"CSRF Protection","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Fcsrf","docs\u002Fauth-h3client\u002F01.essentials\u002F02.csrf",{"title":298,"path":299,"stem":300},"Auth Flows","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Fauth-flows","docs\u002Fauth-h3client\u002F01.essentials\u002F03.auth-flows",{"title":302,"path":303,"stem":304},"OAuth and OIDC","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Foauth","docs\u002Fauth-h3client\u002F01.essentials\u002F04.oauth",{"title":33,"path":306,"stem":307},"\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Fbot-detection","docs\u002Fauth-h3client\u002F01.essentials\u002F05.bot-detection",{"title":309,"path":310,"stem":311},"Cookies","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Fcookies","docs\u002Fauth-h3client\u002F01.essentials\u002F06.cookies",{"title":313,"path":314,"stem":315},"Logging","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Flogging","docs\u002Fauth-h3client\u002F01.essentials\u002F07.logging",{"title":317,"path":318,"stem":319,"children":320},"MFA","\u002Fdocs\u002Fauth-h3client\u002Fmfa","docs\u002Fauth-h3client\u002F02.mfa\u002Findex",[321,322,326,330,334,338],{"title":317,"path":318,"stem":319},{"title":323,"path":324,"stem":325},"Built-in MFA","\u002Fdocs\u002Fauth-h3client\u002Fmfa\u002Fbuilt-in-flow","docs\u002Fauth-h3client\u002F02.mfa\u002F01.built-in-flow",{"title":327,"path":328,"stem":329},"Password Reset","\u002Fdocs\u002Fauth-h3client\u002Fmfa\u002Fpassword-reset","docs\u002Fauth-h3client\u002F02.mfa\u002F02.password-reset",{"title":331,"path":332,"stem":333},"Email Change","\u002Fdocs\u002Fauth-h3client\u002Fmfa\u002Femail-change","docs\u002Fauth-h3client\u002F02.mfa\u002F03.email-change",{"title":335,"path":336,"stem":337},"Custom MFA Flow","\u002Fdocs\u002Fauth-h3client\u002Fmfa\u002Fcustom-flow","docs\u002Fauth-h3client\u002F02.mfa\u002F04.custom-flow",{"title":339,"path":340,"stem":341},"Client-Side MFA","\u002Fdocs\u002Fauth-h3client\u002Fmfa\u002Fclient-side","docs\u002Fauth-h3client\u002F02.mfa\u002F05.client-side",{"title":343,"path":344,"stem":345,"children":346},"Client-side","\u002Fdocs\u002Fauth-h3client\u002Fclient","docs\u002Fauth-h3client\u002F03.client\u002Findex",[347,348,352,356,360],{"title":343,"path":344,"stem":345},{"title":349,"path":350,"stem":351},"useAuthData","\u002Fdocs\u002Fauth-h3client\u002Fclient\u002Fuse-auth-data","docs\u002Fauth-h3client\u002F03.client\u002F00.use-auth-data",{"title":353,"path":354,"stem":355},"useMagicLink","\u002Fdocs\u002Fauth-h3client\u002Fclient\u002Fuse-magic-link","docs\u002Fauth-h3client\u002F03.client\u002F01.use-magic-link",{"title":357,"path":358,"stem":359},"executeRequest","\u002Fdocs\u002Fauth-h3client\u002Fclient\u002Fexecute-request","docs\u002Fauth-h3client\u002F03.client\u002F02.execute-request",{"title":361,"path":362,"stem":363},"getCsrfToken","\u002Fdocs\u002Fauth-h3client\u002Fclient\u002Fget-csrf-token","docs\u002Fauth-h3client\u002F03.client\u002F03.get-csrf-token",{"title":38,"path":365,"stem":366},"\u002Fdocs\u002Fauth-h3client\u002Fsecurity","docs\u002Fauth-h3client\u002F04.security",{"title":368,"path":369,"stem":370,"children":371,"page":53},"Guides","\u002Fdocs\u002Fauth-h3client\u002Fguides","docs\u002Fauth-h3client\u002F05.guides",[372,376,380,384],{"title":373,"path":374,"stem":375},"H3 and Nitro Setup","\u002Fdocs\u002Fauth-h3client\u002Fguides\u002Fh3-nitro","docs\u002Fauth-h3client\u002F05.guides\u002F00.h3-nitro",{"title":377,"path":378,"stem":379},"HMAC Inter-service Auth","\u002Fdocs\u002Fauth-h3client\u002Fguides\u002Fhmac","docs\u002Fauth-h3client\u002F05.guides\u002Fhmac",{"title":381,"path":382,"stem":383},"Image Upload","\u002Fdocs\u002Fauth-h3client\u002Fguides\u002Fimage-upload","docs\u002Fauth-h3client\u002F05.guides\u002Fimage-upload",{"title":385,"path":386,"stem":387},"mTLS Configuration","\u002Fdocs\u002Fauth-h3client\u002Fguides\u002Fmtls","docs\u002Fauth-h3client\u002F05.guides\u002Fmtls",{"title":389,"path":390,"stem":391},"Configuration","\u002Fdocs\u002Fauth-h3client\u002Fconfiguration","docs\u002Fauth-h3client\u002F06.configuration",{"title":393,"path":394,"stem":395,"children":396},"API Reference","\u002Fdocs\u002Fauth-h3client\u002Fapi","docs\u002Fauth-h3client\u002F07.api\u002Findex",[397,398,402,406,410],{"title":393,"path":394,"stem":395},{"title":399,"path":400,"stem":401},"Routes Reference","\u002Fdocs\u002Fauth-h3client\u002Fapi\u002Fcontrollers","docs\u002Fauth-h3client\u002F07.api\u002F00.controllers",{"title":403,"path":404,"stem":405},"Middleware Reference","\u002Fdocs\u002Fauth-h3client\u002Fapi\u002Fmiddleware","docs\u002Fauth-h3client\u002F07.api\u002F01.middleware",{"title":407,"path":408,"stem":409},"Client-side Reference","\u002Fdocs\u002Fauth-h3client\u002Fapi\u002Fcomposables","docs\u002Fauth-h3client\u002F07.api\u002F02.composables",{"title":70,"path":411,"stem":412},"\u002Fdocs\u002Fauth-h3client\u002Fapi\u002Futilities","docs\u002Fauth-h3client\u002F07.api\u002F03.utilities",{"title":414,"path":35,"stem":415,"children":416},"Bot Detector","docs\u002Fbot-detection\u002Findex",[417,418,421,425,429,448,522,525,528],{"title":414,"path":35,"stem":415},{"title":14,"path":419,"stem":420},"\u002Fdocs\u002Fbot-detection\u002Fgetting-started","docs\u002Fbot-detection\u002F00.getting-started",{"title":422,"path":423,"stem":424},"CLI","\u002Fdocs\u002Fbot-detection\u002Fcli","docs\u002Fbot-detection\u002F01.cli",{"title":426,"path":427,"stem":428},"Data Sources","\u002Fdocs\u002Fbot-detection\u002Fdata-sources","docs\u002Fbot-detection\u002F02.data-sources",{"title":368,"path":430,"stem":431,"children":432,"page":53},"\u002Fdocs\u002Fbot-detection\u002Fguides","docs\u002Fbot-detection\u002F03.guides",[433,437,441,444],{"title":434,"path":435,"stem":436},"Custom Checkers","\u002Fdocs\u002Fbot-detection\u002Fguides\u002Fcustom","docs\u002Fbot-detection\u002F03.guides\u002FCUSTOM",{"title":438,"path":439,"stem":440},"Scheduling Database Generation","\u002Fdocs\u002Fbot-detection\u002Fguides\u002Fgenerate","docs\u002Fbot-detection\u002F03.guides\u002FGENERATE",{"title":313,"path":442,"stem":443},"\u002Fdocs\u002Fbot-detection\u002Fguides\u002Flogging","docs\u002Fbot-detection\u002F03.guides\u002FLOGGING",{"title":445,"path":446,"stem":447},"Score Modes and Reputation Healing","\u002Fdocs\u002Fbot-detection\u002Fguides\u002Fscore","docs\u002Fbot-detection\u002F03.guides\u002FSCORE",{"title":449,"path":450,"stem":451,"children":452},"Checkers","\u002Fdocs\u002Fbot-detection\u002Fcheckers","docs\u002Fbot-detection\u002F04.checkers\u002Findex",[453,454,458,462,466,470,474,478,482,486,490,494,498,502,506,510,514,518],{"title":449,"path":450,"stem":451},{"title":455,"path":456,"stem":457},"IP Validation","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fip-validation","docs\u002Fbot-detection\u002F04.checkers\u002F01.ip-validation",{"title":459,"path":460,"stem":461},"Good \u002F Bad Bot Verification","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fgood-bots","docs\u002Fbot-detection\u002F04.checkers\u002F02.good-bots",{"title":463,"path":464,"stem":465},"Browser & Device Fingerprint","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fbrowser-device","docs\u002Fbot-detection\u002F04.checkers\u002F03.browser-device",{"title":467,"path":468,"stem":469},"Locale Map","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Flocale-map","docs\u002Fbot-detection\u002F04.checkers\u002F04.locale-map",{"title":471,"path":472,"stem":473},"Known Threats","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fknown-threats","docs\u002Fbot-detection\u002F04.checkers\u002F05.known-threats",{"title":475,"path":476,"stem":477},"ASN Classification","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fasn-classification","docs\u002Fbot-detection\u002F04.checkers\u002F06.asn-classification",{"title":479,"path":480,"stem":481},"Tor Analysis","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Ftor-analysis","docs\u002Fbot-detection\u002F04.checkers\u002F07.tor-analysis",{"title":483,"path":484,"stem":485},"Timezone Consistency","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Ftimezone-consistency","docs\u002Fbot-detection\u002F04.checkers\u002F08.timezone-consistency",{"title":487,"path":488,"stem":489},"Honeypot","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fhoneypot","docs\u002Fbot-detection\u002F04.checkers\u002F09.honeypot",{"title":491,"path":492,"stem":493},"Known Bad IPs","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fknown-bad-ips","docs\u002Fbot-detection\u002F04.checkers\u002F10.known-bad-ips",{"title":495,"path":496,"stem":497},"Behavior Rate","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fbehavior-rate","docs\u002Fbot-detection\u002F04.checkers\u002F11.behavior-rate",{"title":499,"path":500,"stem":501},"Proxy \u002F ISP \u002F Cookie","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fproxy-isp-cookies","docs\u002Fbot-detection\u002F04.checkers\u002F12.proxy-isp-cookies",{"title":503,"path":504,"stem":505},"Session Coherence","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fsession-coherence","docs\u002Fbot-detection\u002F04.checkers\u002F13.session-coherence",{"title":507,"path":508,"stem":509},"Velocity Fingerprint","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fvelocity-fingerprint","docs\u002Fbot-detection\u002F04.checkers\u002F14.velocity-fingerprint",{"title":511,"path":512,"stem":513},"UA & Header Analysis","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fua-header","docs\u002Fbot-detection\u002F04.checkers\u002F15.ua-header",{"title":515,"path":516,"stem":517},"Geolocation","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fgeolocation","docs\u002Fbot-detection\u002F04.checkers\u002F16.geolocation",{"title":519,"path":520,"stem":521},"Known Bad User-Agents","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fknown-bad-ua","docs\u002Fbot-detection\u002F04.checkers\u002F17.known-bad-ua",{"title":38,"path":523,"stem":524},"\u002Fdocs\u002Fbot-detection\u002Fsecurity","docs\u002Fbot-detection\u002F04.security",{"title":393,"path":526,"stem":527},"\u002Fdocs\u002Fbot-detection\u002Fapi","docs\u002Fbot-detection\u002F05.api",{"title":389,"path":529,"stem":530},"\u002Fdocs\u002Fbot-detection\u002Fconfiguration","docs\u002Fbot-detection\u002F06.configuration",{"title":532,"path":11,"stem":533,"children":534},"Introduction","docs\u002Fgetting-started\u002Findex",[535],{"title":532,"path":11,"stem":533},{"title":27,"path":29,"stem":537,"children":538},"docs\u002Fiam\u002Findex",[539,540,543,678,681,697,700],{"title":27,"path":29,"stem":537},{"title":14,"path":541,"stem":542},"\u002Fdocs\u002Fiam\u002Fgetting-started","docs\u002Fiam\u002F00.getting-started",{"title":280,"path":544,"stem":545,"children":546},"\u002Fdocs\u002Fiam\u002Fessentials","docs\u002Fiam\u002F01.essentials\u002Findex",[547,548,552,556,560,564,568,572,576,580,584,588,591,595,599,603,607,610,614,618,621,625,628],{"title":280,"path":544,"stem":545},{"title":549,"path":550,"stem":551},"Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Ftokens","docs\u002Fiam\u002F01.essentials\u002F00.tokens",{"title":553,"path":554,"stem":555},"Access Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Faccess-tokens","docs\u002Fiam\u002F01.essentials\u002F01.access-tokens",{"title":557,"path":558,"stem":559},"Refresh Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Frefresh-tokens","docs\u002Fiam\u002F01.essentials\u002F02.refresh-tokens",{"title":561,"path":562,"stem":563},"Anomaly Detection","\u002Fdocs\u002Fiam\u002Fessentials\u002Fanomalies","docs\u002Fiam\u002F01.essentials\u002F03.anomalies",{"title":565,"path":566,"stem":567},"Signup","\u002Fdocs\u002Fiam\u002Fessentials\u002Fsignup","docs\u002Fiam\u002F01.essentials\u002F04.signup",{"title":569,"path":570,"stem":571},"Login","\u002Fdocs\u002Fiam\u002Fessentials\u002Flogin","docs\u002Fiam\u002F01.essentials\u002F05.login",{"title":573,"path":574,"stem":575},"Logout","\u002Fdocs\u002Fiam\u002Fessentials\u002Flogout","docs\u002Fiam\u002F01.essentials\u002F06.logout",{"title":577,"path":578,"stem":579},"OAuth","\u002Fdocs\u002Fiam\u002Fessentials\u002Foauth","docs\u002Fiam\u002F01.essentials\u002F07.oauth",{"title":581,"path":582,"stem":583},"Magic Links","\u002Fdocs\u002Fiam\u002Fessentials\u002Fmagic-links","docs\u002Fiam\u002F01.essentials\u002F08.magic-links",{"title":585,"path":586,"stem":587},"Emails","\u002Fdocs\u002Fiam\u002Fessentials\u002Femails","docs\u002Fiam\u002F01.essentials\u002F09.emails",{"title":317,"path":589,"stem":590},"\u002Fdocs\u002Fiam\u002Fessentials\u002Fmfa","docs\u002Fiam\u002F01.essentials\u002F10.mfa",{"title":592,"path":593,"stem":594},"Fingerprinting","\u002Fdocs\u002Fiam\u002Fessentials\u002Ffingerprinting","docs\u002Fiam\u002F01.essentials\u002F11.fingerprinting",{"title":596,"path":597,"stem":598},"Backend for Frontend","\u002Fdocs\u002Fiam\u002Fessentials\u002Fbff","docs\u002Fiam\u002F01.essentials\u002F12.bff",{"title":600,"path":601,"stem":602},"HMAC Authentication","\u002Fdocs\u002Fiam\u002Fessentials\u002Fhmac","docs\u002Fiam\u002F01.essentials\u002F13.hmac",{"title":604,"path":605,"stem":606},"XSS Protection","\u002Fdocs\u002Fiam\u002Fessentials\u002Fxss","docs\u002Fiam\u002F01.essentials\u002F14.xss",{"title":313,"path":608,"stem":609},"\u002Fdocs\u002Fiam\u002Fessentials\u002Flogging","docs\u002Fiam\u002F01.essentials\u002F15.logging",{"title":611,"path":612,"stem":613},"Rate Limiting","\u002Fdocs\u002Fiam\u002Fessentials\u002Frate-limiting","docs\u002Fiam\u002F01.essentials\u002F16.rate-limiting",{"title":615,"path":616,"stem":617},"Database","\u002Fdocs\u002Fiam\u002Fessentials\u002Fdatabase","docs\u002Fiam\u002F01.essentials\u002F17.database",{"title":309,"path":619,"stem":620},"\u002Fdocs\u002Fiam\u002Fessentials\u002Fcookies","docs\u002Fiam\u002F01.essentials\u002F18.cookies",{"title":622,"path":623,"stem":624},"Service Startup","\u002Fdocs\u002Fiam\u002Fessentials\u002Fservice","docs\u002Fiam\u002F01.essentials\u002F19.service",{"title":327,"path":626,"stem":627},"\u002Fdocs\u002Fiam\u002Fessentials\u002Fpassword-reset","docs\u002Fiam\u002F01.essentials\u002F20.password-reset",{"title":629,"path":630,"stem":631,"children":632},"API Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi","docs\u002Fiam\u002F01.essentials\u002F21.api\u002Findex",[633,634,638,642,672,675],{"title":629,"path":630,"stem":631},{"title":635,"path":636,"stem":637},"Creating Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fcreation","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F00.creation",{"title":639,"path":640,"stem":641},"Verifying Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fverification","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F01.verification",{"title":643,"path":644,"stem":645,"children":646},"Manage Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002Findex",[647,648,652,656,660,664,668],{"title":643,"path":644,"stem":645},{"title":649,"path":650,"stem":651},"Privileges","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Fprivilege","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F00.privilege",{"title":653,"path":654,"stem":655},"Revocation","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Frevocation","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F01.revocation",{"title":657,"path":658,"stem":659},"Rotation","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Frotation","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F02.rotation",{"title":661,"path":662,"stem":663},"IP Restriction","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Fip-updates","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F03.ip-updates",{"title":665,"path":666,"stem":667},"Metadata","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Fmetadata","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F04.metadata",{"title":669,"path":670,"stem":671},"Token Listing","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Flist","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F05.list",{"title":611,"path":673,"stem":674},"\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Frate-limiting","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F03.rate-limiting",{"title":38,"path":676,"stem":677},"\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fsecurity","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F04.security",{"title":38,"path":679,"stem":680},"\u002Fdocs\u002Fiam\u002Fsecurity","docs\u002Fiam\u002F02.security",{"title":368,"path":682,"stem":683,"children":684,"page":53},"\u002Fdocs\u002Fiam\u002Fguides","docs\u002Fiam\u002F03.guides",[685,689,693],{"title":686,"path":687,"stem":688},"Deployment","\u002Fdocs\u002Fiam\u002Fguides\u002Fdeployment","docs\u002Fiam\u002F03.guides\u002Fdeployment",{"title":690,"path":691,"stem":692},"Operation Scripts","\u002Fdocs\u002Fiam\u002Fguides\u002Foperation-scripts","docs\u002Fiam\u002F03.guides\u002Foperation-scripts",{"title":694,"path":695,"stem":696},"Role-Based Access Control","\u002Fdocs\u002Fiam\u002Fguides\u002Frbac","docs\u002Fiam\u002F03.guides\u002Frbac",{"title":389,"path":698,"stem":699},"\u002Fdocs\u002Fiam\u002Fconfiguration","docs\u002Fiam\u002F04.configuration",{"title":701,"path":702,"stem":703,"children":704,"page":53},"Api","\u002Fdocs\u002Fiam\u002Fapi","docs\u002Fiam\u002F05.API",[705,708,711],{"title":393,"path":706,"stem":707},"\u002Fdocs\u002Fiam\u002Fapi\u002Fapi","docs\u002Fiam\u002F05.API\u002F00.api",{"title":403,"path":709,"stem":710},"\u002Fdocs\u002Fiam\u002Fapi\u002Fmiddlewares","docs\u002Fiam\u002F05.API\u002F02.middlewares",{"title":399,"path":712,"stem":713},"\u002Fdocs\u002Fiam\u002Fapi\u002Froutes","docs\u002Fiam\u002F05.API\u002F03.routes",{"title":40,"path":42,"stem":715,"children":716},"docs\u002Fshield-base\u002Findex",[717,718,721,725,766,770,774,778],{"title":40,"path":42,"stem":715},{"title":14,"path":719,"stem":720},"\u002Fdocs\u002Fshield-base\u002Fgetting-started","docs\u002Fshield-base\u002F00.getting-started",{"title":722,"path":723,"stem":724},"CLI Reference","\u002Fdocs\u002Fshield-base\u002Fcli","docs\u002Fshield-base\u002F01.cli",{"title":426,"path":726,"stem":727,"children":728},"\u002Fdocs\u002Fshield-base\u002Fdata-sources","docs\u002Fshield-base\u002F02.data-sources\u002Findex",[729,730,734,738,742,746,750,754,758,762],{"title":426,"path":726,"stem":727},{"title":731,"path":732,"stem":733},"BGP \u002F ASN","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fbgp","docs\u002Fshield-base\u002F02.data-sources\u002Fbgp",{"title":735,"path":736,"stem":737},"City Geolocation","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fcity","docs\u002Fshield-base\u002F02.data-sources\u002Fcity",{"title":739,"path":740,"stem":741},"Country Geolocation","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fcountry","docs\u002Fshield-base\u002F02.data-sources\u002Fcountry",{"title":743,"path":744,"stem":745},"Verified Crawlers","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fcrawlers","docs\u002Fshield-base\u002F02.data-sources\u002Fcrawlers",{"title":747,"path":748,"stem":749},"Disposable Emails","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Femail","docs\u002Fshield-base\u002F02.data-sources\u002Femail",{"title":751,"path":752,"stem":753},"FireHOL Threat Intelligence","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Ffirehol","docs\u002Fshield-base\u002F02.data-sources\u002Ffirehol",{"title":755,"path":756,"stem":757},"Proxy Detection","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fproxy","docs\u002Fshield-base\u002F02.data-sources\u002Fproxy",{"title":759,"path":760,"stem":761},"Tor Nodes","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Ftor","docs\u002Fshield-base\u002F02.data-sources\u002Ftor",{"title":763,"path":764,"stem":765},"Suspicious User-Agents","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fuseragent","docs\u002Fshield-base\u002F02.data-sources\u002Fuseragent",{"title":767,"path":768,"stem":769},"Programmatic Usage","\u002Fdocs\u002Fshield-base\u002Fusage","docs\u002Fshield-base\u002F03.usage",{"title":771,"path":772,"stem":773},"Custom Data Sources","\u002Fdocs\u002Fshield-base\u002Fcustom-data-sources","docs\u002Fshield-base\u002F04.custom-data-sources",{"title":775,"path":776,"stem":777},"TypeScript Types","\u002Fdocs\u002Fshield-base\u002Ftypes","docs\u002Fshield-base\u002F05.types",{"title":393,"path":779,"stem":780},"\u002Fdocs\u002Fshield-base\u002Fapi","docs\u002Fshield-base\u002F06.api",{"title":70,"path":48,"stem":71,"children":782},[783,784,789,798,823],{"title":70,"path":48,"stem":71},{"title":75,"path":76,"stem":77,"children":785,"page":53},[786,787,788],{"title":80,"path":81,"stem":82},{"title":84,"path":85,"stem":86},{"title":88,"path":89,"stem":90},{"title":92,"path":93,"stem":94,"children":790,"page":53},[791,792,793,794,795,796,797],{"title":97,"path":98,"stem":99},{"title":101,"path":102,"stem":103},{"title":105,"path":106,"stem":107},{"title":109,"path":110,"stem":111},{"title":113,"path":114,"stem":115},{"title":117,"path":118,"stem":119},{"title":121,"path":122,"stem":123},{"title":125,"path":126,"stem":127,"children":799,"page":53},[800,801,802,803,804,805,806,807,808,809,810,811,812,813,814,815,816,817,818,819,820,821,822],{"title":130,"path":131,"stem":132},{"title":134,"path":135,"stem":136},{"title":138,"path":139,"stem":140},{"title":142,"path":143,"stem":144},{"title":146,"path":147,"stem":148},{"title":150,"path":151,"stem":152},{"title":154,"path":155,"stem":156},{"title":158,"path":159,"stem":160},{"title":162,"path":163,"stem":164},{"title":166,"path":167,"stem":168},{"title":170,"path":171,"stem":172},{"title":174,"path":175,"stem":176},{"title":178,"path":179,"stem":180},{"title":182,"path":183,"stem":184},{"title":186,"path":187,"stem":188},{"title":190,"path":191,"stem":192},{"title":194,"path":195,"stem":196},{"title":198,"path":199,"stem":200},{"title":202,"path":203,"stem":204},{"title":206,"path":207,"stem":208},{"title":210,"path":211,"stem":212},{"title":214,"path":215,"stem":216},{"title":218,"path":219,"stem":220},{"title":222,"path":223,"stem":224,"children":824},[825,826,827,828,829,830,831,832,833,834],{"title":222,"path":223,"stem":224},{"title":228,"path":229,"stem":230},{"title":232,"path":233,"stem":234},{"title":236,"path":237,"stem":238},{"title":240,"path":241,"stem":242},{"title":244,"path":245,"stem":246},{"title":248,"path":249,"stem":250},{"title":252,"path":253,"stem":254},{"title":256,"path":257,"stem":258},{"title":260,"path":261,"stem":262},{"id":4,"extension":5,"links":836,"meta":847,"stem":62,"__hash__":63},[837,845,846],{"nested":8,"label":9,"icon":10,"to":11,"children":838},[839,840,841,842,843,844],{"label":14,"icon":15,"to":11,"description":16,"github":17,"badge":18},{"label":20,"icon":21,"to":22,"description":23,"github":24,"badge":25},{"label":27,"icon":28,"to":29,"description":30,"github":31,"badge":25},{"label":33,"icon":34,"to":35,"description":36,"github":37,"badge":38},{"label":40,"icon":41,"to":42,"description":43,"github":44,"badge":38},{"label":46,"icon":47,"to":48,"description":49,"github":50,"badge":51},{"nested":53,"label":54,"icon":55,"to":56},{"nested":53,"label":58,"icon":59,"to":60},{},{"id":849,"title":109,"body":850,"description":1451,"extension":1452,"icon":1453,"meta":1454,"module":1455,"navigation":8,"path":110,"rawbody":1456,"seo":1457,"stem":111,"__hash__":1458},"docs\u002Fdocs\u002Futils\u002Fserver\u002Frun.md",{"type":851,"value":852,"toc":1446},"minimark",[853,865,880,886,891,1136,1140,1213,1217,1220,1442],[854,855,856,857,860,861,864],"p",{},"The ",[858,859,109],"code",{}," utility is a modernized, Promise-based wrapper around Node.js's native ",[858,862,863],{},"child_process.exec",".",[854,866,867,868,871,872,875,876,879],{},"It enables seamless execution of shell commands within an ",[858,869,870],{},"async\u002Fawait"," flow, automatically parsing and returning both ",[858,873,874],{},"stdout"," and ",[858,877,878],{},"stderr",". It also overrides the restrictive default buffer size, allowing for processes with massive outputs without crashing.",[881,882,883],"caution",{},[854,884,885],{},"This utility designed to be used server side and its provided input is not sanitized. Do not pass untrusted values to it.",[887,888,890],"h2",{"id":889},"definition","Definition",[892,893,899],"pre",{"className":894,"code":895,"filename":896,"language":897,"meta":898,"style":898},"language-ts shiki shiki-themes light-plus light-plus dracula","import type { ExecOptions } from 'node:child_process';\n\nexport interface RunResult {\n  stdout: string | Buffer;\n  stderr: string | Buffer;\n}\n\n\u002F**\n * Executes a shell command and returns the output.\n *\n * @param command - The shell command to execute\n * @param options - Optional node:child_process ExecOptions\n * @returns A promise resolving to the stdout and stderr\n *\u002F\nexport const run = async (command: string, options: ExecOptions = {}): Promise\u003CRunResult>\n","run.ts","ts","",[858,900,901,941,947,964,985,1001,1007,1012,1019,1025,1031,1047,1060,1071,1077],{"__ignoreMap":898},[902,903,906,910,913,917,921,924,927,931,935,938],"span",{"class":904,"line":905},"line",1,[902,907,909],{"class":908},"sZ328","import",[902,911,912],{"class":908}," type",[902,914,916],{"class":915},"sDd4n"," { ",[902,918,920],{"class":919},"sjsA6","ExecOptions",[902,922,923],{"class":915}," } ",[902,925,926],{"class":908},"from",[902,928,930],{"class":929},"sFkSl"," '",[902,932,934],{"class":933},"sFB1V","node:child_process",[902,936,937],{"class":929},"'",[902,939,940],{"class":915},";\n",[902,942,944],{"class":904,"line":943},2,[902,945,946],{"emptyLinePlaceholder":8},"\n",[902,948,950,953,957,961],{"class":904,"line":949},3,[902,951,952],{"class":908},"export",[902,954,956],{"class":955},"sl46w"," interface",[902,958,960],{"class":959},"sFs1U"," RunResult",[902,962,963],{"class":915}," {\n",[902,965,967,970,974,977,980,983],{"class":904,"line":966},4,[902,968,969],{"class":919},"  stdout",[902,971,973],{"class":972},"saOXh",":",[902,975,976],{"class":959}," string",[902,978,979],{"class":972}," |",[902,981,982],{"class":959}," Buffer",[902,984,940],{"class":915},[902,986,988,991,993,995,997,999],{"class":904,"line":987},5,[902,989,990],{"class":919},"  stderr",[902,992,973],{"class":972},[902,994,976],{"class":959},[902,996,979],{"class":972},[902,998,982],{"class":959},[902,1000,940],{"class":915},[902,1002,1004],{"class":904,"line":1003},6,[902,1005,1006],{"class":915},"}\n",[902,1008,1010],{"class":904,"line":1009},7,[902,1011,946],{"emptyLinePlaceholder":8},[902,1013,1015],{"class":904,"line":1014},8,[902,1016,1018],{"class":1017},"sghk6","\u002F**\n",[902,1020,1022],{"class":904,"line":1021},9,[902,1023,1024],{"class":1017}," * Executes a shell command and returns the output.\n",[902,1026,1028],{"class":904,"line":1027},10,[902,1029,1030],{"class":1017}," *\n",[902,1032,1034,1037,1040,1044],{"class":904,"line":1033},11,[902,1035,1036],{"class":1017}," * ",[902,1038,1039],{"class":955},"@param",[902,1041,1043],{"class":1042},"sygFZ"," command",[902,1045,1046],{"class":1017}," - The shell command to execute\n",[902,1048,1050,1052,1054,1057],{"class":904,"line":1049},12,[902,1051,1036],{"class":1017},[902,1053,1039],{"class":955},[902,1055,1056],{"class":1042}," options",[902,1058,1059],{"class":1017}," - Optional node:child_process ExecOptions\n",[902,1061,1063,1065,1068],{"class":904,"line":1062},13,[902,1064,1036],{"class":1017},[902,1066,1067],{"class":955},"@returns",[902,1069,1070],{"class":1017}," A promise resolving to the stdout and stderr\n",[902,1072,1074],{"class":904,"line":1073},14,[902,1075,1076],{"class":1017}," *\u002F\n",[902,1078,1080,1082,1085,1089,1092,1095,1098,1101,1103,1105,1108,1111,1113,1116,1118,1121,1123,1126,1129,1133],{"class":904,"line":1079},15,[902,1081,952],{"class":908},[902,1083,1084],{"class":955}," const",[902,1086,1088],{"class":1087},"sHOzp"," run",[902,1090,1091],{"class":972}," =",[902,1093,1094],{"class":955}," async",[902,1096,1097],{"class":915}," (",[902,1099,1100],{"class":1042},"command",[902,1102,973],{"class":972},[902,1104,976],{"class":959},[902,1106,1107],{"class":915},", ",[902,1109,1110],{"class":1042},"options",[902,1112,973],{"class":972},[902,1114,1115],{"class":959}," ExecOptions",[902,1117,1091],{"class":972},[902,1119,1120],{"class":915}," {})",[902,1122,973],{"class":972},[902,1124,1125],{"class":959}," Promise",[902,1127,1128],{"class":915},"\u003C",[902,1130,1132],{"class":1131},"sW-rI","RunResult",[902,1134,1135],{"class":915},">\n",[887,1137,1139],{"id":1138},"parameters","Parameters",[1141,1142,1143,1162],"table",{},[1144,1145,1146],"thead",{},[1147,1148,1149,1153,1156,1159],"tr",{},[1150,1151,1152],"th",{},"Parameter",[1150,1154,1155],{},"Type",[1150,1157,1158],{},"Required",[1150,1160,1161],{},"Description",[1163,1164,1165,1183],"tbody",{},[1147,1166,1167,1172,1177,1180],{},[1168,1169,1170],"td",{},[858,1171,1100],{},[1168,1173,1174],{},[858,1175,1176],{},"string",[1168,1178,1179],{},"Yes",[1168,1181,1182],{},"The literal shell command string to execute.",[1147,1184,1185,1189,1193,1196],{},[1168,1186,1187],{},[858,1188,1110],{},[1168,1190,1191],{},[858,1192,920],{},[1168,1194,1195],{},"No",[1168,1197,1198,1199,1201,1202,1107,1205,1208,1209,1212],{},"Any native Node.js ",[858,1200,920],{}," overrides (like ",[858,1203,1204],{},"cwd",[858,1206,1207],{},"env",", or custom ",[858,1210,1211],{},"maxBuffer",").",[887,1214,1216],{"id":1215},"example-usage","Example Usage",[854,1218,1219],{},"This utility automatically trims whitespace from string outputs and includes robust error logging when a command fails or throws an exception.",[892,1221,1224],{"className":894,"code":1222,"filename":1223,"language":897,"meta":898,"style":898},"import { run } from '@riavzon\u002Futils\u002Fserver'\n\nasync function checkSystemMemory() {\n  try {\n    \u002F\u002F Run the 'free -m' command across the system\n    const { stdout, stderr } = await run('free -m');\n\n    if (stderr) {\n      console.warn('Command produced warnings:', stderr);\n    }\n\n    console.log('Memory Stats:\\n', stdout);\n  } catch (error) {\n    console.error('Failed to retrieve system memory.');\n    \u002F\u002F The run utility has already safely logged the exact stderr payload internally\n  }\n}\n","example.ts",[858,1225,1226,1246,1250,1264,1271,1276,1313,1317,1329,1354,1359,1363,1392,1407,1426,1431,1437],{"__ignoreMap":898},[902,1227,1228,1230,1232,1234,1236,1238,1240,1243],{"class":904,"line":905},[902,1229,909],{"class":908},[902,1231,916],{"class":915},[902,1233,109],{"class":919},[902,1235,923],{"class":915},[902,1237,926],{"class":908},[902,1239,930],{"class":929},[902,1241,1242],{"class":933},"@riavzon\u002Futils\u002Fserver",[902,1244,1245],{"class":929},"'\n",[902,1247,1248],{"class":904,"line":943},[902,1249,946],{"emptyLinePlaceholder":8},[902,1251,1252,1255,1258,1261],{"class":904,"line":949},[902,1253,1254],{"class":955},"async",[902,1256,1257],{"class":955}," function",[902,1259,1260],{"class":1087}," checkSystemMemory",[902,1262,1263],{"class":915},"() {\n",[902,1265,1266,1269],{"class":904,"line":966},[902,1267,1268],{"class":908},"  try",[902,1270,963],{"class":915},[902,1272,1273],{"class":904,"line":987},[902,1274,1275],{"class":1017},"    \u002F\u002F Run the 'free -m' command across the system\n",[902,1277,1278,1281,1283,1286,1288,1290,1292,1295,1298,1300,1303,1305,1308,1310],{"class":904,"line":1003},[902,1279,1280],{"class":955},"    const",[902,1282,916],{"class":915},[902,1284,874],{"class":1285},"s3JHE",[902,1287,1107],{"class":915},[902,1289,878],{"class":1285},[902,1291,923],{"class":915},[902,1293,1294],{"class":972},"=",[902,1296,1297],{"class":908}," await",[902,1299,1088],{"class":1087},[902,1301,1302],{"class":915},"(",[902,1304,937],{"class":929},[902,1306,1307],{"class":933},"free -m",[902,1309,937],{"class":929},[902,1311,1312],{"class":915},");\n",[902,1314,1315],{"class":904,"line":1009},[902,1316,946],{"emptyLinePlaceholder":8},[902,1318,1319,1322,1324,1326],{"class":904,"line":1014},[902,1320,1321],{"class":908},"    if",[902,1323,1097],{"class":915},[902,1325,878],{"class":919},[902,1327,1328],{"class":915},") {\n",[902,1330,1331,1334,1336,1339,1341,1343,1346,1348,1350,1352],{"class":904,"line":1021},[902,1332,1333],{"class":919},"      console",[902,1335,864],{"class":915},[902,1337,1338],{"class":1087},"warn",[902,1340,1302],{"class":915},[902,1342,937],{"class":929},[902,1344,1345],{"class":933},"Command produced warnings:",[902,1347,937],{"class":929},[902,1349,1107],{"class":915},[902,1351,878],{"class":919},[902,1353,1312],{"class":915},[902,1355,1356],{"class":904,"line":1027},[902,1357,1358],{"class":915},"    }\n",[902,1360,1361],{"class":904,"line":1033},[902,1362,946],{"emptyLinePlaceholder":8},[902,1364,1365,1368,1370,1373,1375,1377,1380,1384,1386,1388,1390],{"class":904,"line":1049},[902,1366,1367],{"class":919},"    console",[902,1369,864],{"class":915},[902,1371,1372],{"class":1087},"log",[902,1374,1302],{"class":915},[902,1376,937],{"class":929},[902,1378,1379],{"class":933},"Memory Stats:",[902,1381,1383],{"class":1382},"st6lo","\\n",[902,1385,937],{"class":929},[902,1387,1107],{"class":915},[902,1389,874],{"class":919},[902,1391,1312],{"class":915},[902,1393,1394,1397,1400,1402,1405],{"class":904,"line":1062},[902,1395,1396],{"class":915},"  } ",[902,1398,1399],{"class":908},"catch",[902,1401,1097],{"class":915},[902,1403,1404],{"class":919},"error",[902,1406,1328],{"class":915},[902,1408,1409,1411,1413,1415,1417,1419,1422,1424],{"class":904,"line":1073},[902,1410,1367],{"class":919},[902,1412,864],{"class":915},[902,1414,1404],{"class":1087},[902,1416,1302],{"class":915},[902,1418,937],{"class":929},[902,1420,1421],{"class":933},"Failed to retrieve system memory.",[902,1423,937],{"class":929},[902,1425,1312],{"class":915},[902,1427,1428],{"class":904,"line":1079},[902,1429,1430],{"class":1017},"    \u002F\u002F The run utility has already safely logged the exact stderr payload internally\n",[902,1432,1434],{"class":904,"line":1433},16,[902,1435,1436],{"class":915},"  }\n",[902,1438,1440],{"class":904,"line":1439},17,[902,1441,1006],{"class":915},[1443,1444,1445],"style",{},"html pre.shiki code .sZ328, html code.shiki .sZ328{--shiki-light:#AF00DB;--shiki-default:#AF00DB;--shiki-dark:#FF79C6}html pre.shiki code .sDd4n, html code.shiki .sDd4n{--shiki-light:#000000;--shiki-default:#000000;--shiki-dark:#F8F8F2}html pre.shiki code .sjsA6, html code.shiki .sjsA6{--shiki-light:#001080;--shiki-default:#001080;--shiki-dark:#F8F8F2}html pre.shiki code .sFkSl, html code.shiki .sFkSl{--shiki-light:#A31515;--shiki-default:#A31515;--shiki-dark:#E9F284}html pre.shiki code .sFB1V, html code.shiki .sFB1V{--shiki-light:#A31515;--shiki-default:#A31515;--shiki-dark:#F1FA8C}html pre.shiki code .sl46w, html code.shiki .sl46w{--shiki-light:#0000FF;--shiki-default:#0000FF;--shiki-dark:#FF79C6}html pre.shiki code .sFs1U, html code.shiki .sFs1U{--shiki-light:#267F99;--shiki-light-font-style:inherit;--shiki-default:#267F99;--shiki-default-font-style:inherit;--shiki-dark:#8BE9FD;--shiki-dark-font-style:italic}html pre.shiki code .saOXh, html code.shiki .saOXh{--shiki-light:#000000;--shiki-default:#000000;--shiki-dark:#FF79C6}html pre.shiki code .sghk6, html code.shiki .sghk6{--shiki-light:#008000;--shiki-default:#008000;--shiki-dark:#6272A4}html pre.shiki code .sygFZ, html code.shiki .sygFZ{--shiki-light:#001080;--shiki-light-font-style:inherit;--shiki-default:#001080;--shiki-default-font-style:inherit;--shiki-dark:#FFB86C;--shiki-dark-font-style:italic}html pre.shiki code .sHOzp, html code.shiki .sHOzp{--shiki-light:#795E26;--shiki-default:#795E26;--shiki-dark:#50FA7B}html pre.shiki code .sW-rI, html code.shiki .sW-rI{--shiki-light:#267F99;--shiki-light-font-style:inherit;--shiki-default:#267F99;--shiki-default-font-style:inherit;--shiki-dark:#FFB86C;--shiki-dark-font-style:italic}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s3JHE, html code.shiki .s3JHE{--shiki-light:#0070C1;--shiki-default:#0070C1;--shiki-dark:#F8F8F2}html pre.shiki code .st6lo, html code.shiki .st6lo{--shiki-light:#EE0000;--shiki-default:#EE0000;--shiki-dark:#FF79C6}",{"title":898,"searchDepth":943,"depth":943,"links":1447},[1448,1449,1450],{"id":889,"depth":943,"text":890},{"id":1138,"depth":943,"text":1139},{"id":1215,"depth":943,"text":1216},"Executes a shell command and returns the output via a Promise.","md","i-lucide-terminal",{},null,"---\ntitle: run\ndescription: Executes a shell command and returns the output via a Promise.\nicon: i-lucide-terminal\n---\n\nThe `run` utility is a modernized, Promise-based wrapper around Node.js's native `child_process.exec`.\n\nIt enables seamless execution of shell commands within an `async\u002Fawait` flow, automatically parsing and returning both `stdout` and `stderr`. It also overrides the restrictive default buffer size, allowing for processes with massive outputs without crashing.\n\n::caution\nThis utility designed to be used server side and its provided input is not sanitized. Do not pass untrusted values to it.\n::\n\n## Definition\n\n```ts [run.ts]\nimport type { ExecOptions } from 'node:child_process';\n\nexport interface RunResult {\n  stdout: string | Buffer;\n  stderr: string | Buffer;\n}\n\n\u002F**\n * Executes a shell command and returns the output.\n *\n * @param command - The shell command to execute\n * @param options - Optional node:child_process ExecOptions\n * @returns A promise resolving to the stdout and stderr\n *\u002F\nexport const run = async (command: string, options: ExecOptions = {}): Promise\u003CRunResult>\n```\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `command` | `string` | Yes | The literal shell command string to execute. |\n| `options` | `ExecOptions` | No | Any native Node.js `ExecOptions` overrides (like `cwd`, `env`, or custom `maxBuffer`). |\n\n\n## Example Usage\n\nThis utility automatically trims whitespace from string outputs and includes robust error logging when a command fails or throws an exception.\n\n```ts [example.ts]\nimport { run } from '@riavzon\u002Futils\u002Fserver'\n\nasync function checkSystemMemory() {\n  try {\n    \u002F\u002F Run the 'free -m' command across the system\n    const { stdout, stderr } = await run('free -m');\n\n    if (stderr) {\n      console.warn('Command produced warnings:', stderr);\n    }\n\n    console.log('Memory Stats:\\n', stdout);\n  } catch (error) {\n    console.error('Failed to retrieve system memory.');\n    \u002F\u002F The run utility has already safely logged the exact stderr payload internally\n  }\n}\n```\n",{"title":109,"description":1451},"VnEIsElyCz97Cgfoo2Q8Nysid9qk7EQqMwRnK42QNYM",[1460,1461],{"title":105,"path":106,"stem":107,"children":-1},{"title":113,"path":114,"stem":115,"children":-1},{"id":849,"title":109,"body":1463,"description":1451,"extension":1452,"icon":1453,"meta":1898,"module":1455,"navigation":8,"path":110,"rawbody":1456,"seo":1899,"stem":111,"__hash__":1458},{"type":851,"value":1464,"toc":1893},[1465,1471,1479,1483,1485,1647,1649,1701,1703,1705,1891],[854,1466,856,1467,860,1469,864],{},[858,1468,109],{},[858,1470,863],{},[854,1472,867,1473,871,1475,875,1477,879],{},[858,1474,870],{},[858,1476,874],{},[858,1478,878],{},[881,1480,1481],{},[854,1482,885],{},[887,1484,890],{"id":889},[892,1486,1487],{"className":894,"code":895,"filename":896,"language":897,"meta":898,"style":898},[858,1488,1489,1511,1515,1525,1539,1553,1557,1561,1565,1569,1573,1583,1593,1601,1605],{"__ignoreMap":898},[902,1490,1491,1493,1495,1497,1499,1501,1503,1505,1507,1509],{"class":904,"line":905},[902,1492,909],{"class":908},[902,1494,912],{"class":908},[902,1496,916],{"class":915},[902,1498,920],{"class":919},[902,1500,923],{"class":915},[902,1502,926],{"class":908},[902,1504,930],{"class":929},[902,1506,934],{"class":933},[902,1508,937],{"class":929},[902,1510,940],{"class":915},[902,1512,1513],{"class":904,"line":943},[902,1514,946],{"emptyLinePlaceholder":8},[902,1516,1517,1519,1521,1523],{"class":904,"line":949},[902,1518,952],{"class":908},[902,1520,956],{"class":955},[902,1522,960],{"class":959},[902,1524,963],{"class":915},[902,1526,1527,1529,1531,1533,1535,1537],{"class":904,"line":966},[902,1528,969],{"class":919},[902,1530,973],{"class":972},[902,1532,976],{"class":959},[902,1534,979],{"class":972},[902,1536,982],{"class":959},[902,1538,940],{"class":915},[902,1540,1541,1543,1545,1547,1549,1551],{"class":904,"line":987},[902,1542,990],{"class":919},[902,1544,973],{"class":972},[902,1546,976],{"class":959},[902,1548,979],{"class":972},[902,1550,982],{"class":959},[902,1552,940],{"class":915},[902,1554,1555],{"class":904,"line":1003},[902,1556,1006],{"class":915},[902,1558,1559],{"class":904,"line":1009},[902,1560,946],{"emptyLinePlaceholder":8},[902,1562,1563],{"class":904,"line":1014},[902,1564,1018],{"class":1017},[902,1566,1567],{"class":904,"line":1021},[902,1568,1024],{"class":1017},[902,1570,1571],{"class":904,"line":1027},[902,1572,1030],{"class":1017},[902,1574,1575,1577,1579,1581],{"class":904,"line":1033},[902,1576,1036],{"class":1017},[902,1578,1039],{"class":955},[902,1580,1043],{"class":1042},[902,1582,1046],{"class":1017},[902,1584,1585,1587,1589,1591],{"class":904,"line":1049},[902,1586,1036],{"class":1017},[902,1588,1039],{"class":955},[902,1590,1056],{"class":1042},[902,1592,1059],{"class":1017},[902,1594,1595,1597,1599],{"class":904,"line":1062},[902,1596,1036],{"class":1017},[902,1598,1067],{"class":955},[902,1600,1070],{"class":1017},[902,1602,1603],{"class":904,"line":1073},[902,1604,1076],{"class":1017},[902,1606,1607,1609,1611,1613,1615,1617,1619,1621,1623,1625,1627,1629,1631,1633,1635,1637,1639,1641,1643,1645],{"class":904,"line":1079},[902,1608,952],{"class":908},[902,1610,1084],{"class":955},[902,1612,1088],{"class":1087},[902,1614,1091],{"class":972},[902,1616,1094],{"class":955},[902,1618,1097],{"class":915},[902,1620,1100],{"class":1042},[902,1622,973],{"class":972},[902,1624,976],{"class":959},[902,1626,1107],{"class":915},[902,1628,1110],{"class":1042},[902,1630,973],{"class":972},[902,1632,1115],{"class":959},[902,1634,1091],{"class":972},[902,1636,1120],{"class":915},[902,1638,973],{"class":972},[902,1640,1125],{"class":959},[902,1642,1128],{"class":915},[902,1644,1132],{"class":1131},[902,1646,1135],{"class":915},[887,1648,1139],{"id":1138},[1141,1650,1651,1663],{},[1144,1652,1653],{},[1147,1654,1655,1657,1659,1661],{},[1150,1656,1152],{},[1150,1658,1155],{},[1150,1660,1158],{},[1150,1662,1161],{},[1163,1664,1665,1679],{},[1147,1666,1667,1671,1675,1677],{},[1168,1668,1669],{},[858,1670,1100],{},[1168,1672,1673],{},[858,1674,1176],{},[1168,1676,1179],{},[1168,1678,1182],{},[1147,1680,1681,1685,1689,1691],{},[1168,1682,1683],{},[858,1684,1110],{},[1168,1686,1687],{},[858,1688,920],{},[1168,1690,1195],{},[1168,1692,1198,1693,1201,1695,1107,1697,1208,1699,1212],{},[858,1694,920],{},[858,1696,1204],{},[858,1698,1207],{},[858,1700,1211],{},[887,1702,1216],{"id":1215},[854,1704,1219],{},[892,1706,1707],{"className":894,"code":1222,"filename":1223,"language":897,"meta":898,"style":898},[858,1708,1709,1727,1731,1741,1747,1751,1781,1785,1795,1817,1821,1825,1849,1861,1879,1883,1887],{"__ignoreMap":898},[902,1710,1711,1713,1715,1717,1719,1721,1723,1725],{"class":904,"line":905},[902,1712,909],{"class":908},[902,1714,916],{"class":915},[902,1716,109],{"class":919},[902,1718,923],{"class":915},[902,1720,926],{"class":908},[902,1722,930],{"class":929},[902,1724,1242],{"class":933},[902,1726,1245],{"class":929},[902,1728,1729],{"class":904,"line":943},[902,1730,946],{"emptyLinePlaceholder":8},[902,1732,1733,1735,1737,1739],{"class":904,"line":949},[902,1734,1254],{"class":955},[902,1736,1257],{"class":955},[902,1738,1260],{"class":1087},[902,1740,1263],{"class":915},[902,1742,1743,1745],{"class":904,"line":966},[902,1744,1268],{"class":908},[902,1746,963],{"class":915},[902,1748,1749],{"class":904,"line":987},[902,1750,1275],{"class":1017},[902,1752,1753,1755,1757,1759,1761,1763,1765,1767,1769,1771,1773,1775,1777,1779],{"class":904,"line":1003},[902,1754,1280],{"class":955},[902,1756,916],{"class":915},[902,1758,874],{"class":1285},[902,1760,1107],{"class":915},[902,1762,878],{"class":1285},[902,1764,923],{"class":915},[902,1766,1294],{"class":972},[902,1768,1297],{"class":908},[902,1770,1088],{"class":1087},[902,1772,1302],{"class":915},[902,1774,937],{"class":929},[902,1776,1307],{"class":933},[902,1778,937],{"class":929},[902,1780,1312],{"class":915},[902,1782,1783],{"class":904,"line":1009},[902,1784,946],{"emptyLinePlaceholder":8},[902,1786,1787,1789,1791,1793],{"class":904,"line":1014},[902,1788,1321],{"class":908},[902,1790,1097],{"class":915},[902,1792,878],{"class":919},[902,1794,1328],{"class":915},[902,1796,1797,1799,1801,1803,1805,1807,1809,1811,1813,1815],{"class":904,"line":1021},[902,1798,1333],{"class":919},[902,1800,864],{"class":915},[902,1802,1338],{"class":1087},[902,1804,1302],{"class":915},[902,1806,937],{"class":929},[902,1808,1345],{"class":933},[902,1810,937],{"class":929},[902,1812,1107],{"class":915},[902,1814,878],{"class":919},[902,1816,1312],{"class":915},[902,1818,1819],{"class":904,"line":1027},[902,1820,1358],{"class":915},[902,1822,1823],{"class":904,"line":1033},[902,1824,946],{"emptyLinePlaceholder":8},[902,1826,1827,1829,1831,1833,1835,1837,1839,1841,1843,1845,1847],{"class":904,"line":1049},[902,1828,1367],{"class":919},[902,1830,864],{"class":915},[902,1832,1372],{"class":1087},[902,1834,1302],{"class":915},[902,1836,937],{"class":929},[902,1838,1379],{"class":933},[902,1840,1383],{"class":1382},[902,1842,937],{"class":929},[902,1844,1107],{"class":915},[902,1846,874],{"class":919},[902,1848,1312],{"class":915},[902,1850,1851,1853,1855,1857,1859],{"class":904,"line":1062},[902,1852,1396],{"class":915},[902,1854,1399],{"class":908},[902,1856,1097],{"class":915},[902,1858,1404],{"class":919},[902,1860,1328],{"class":915},[902,1862,1863,1865,1867,1869,1871,1873,1875,1877],{"class":904,"line":1073},[902,1864,1367],{"class":919},[902,1866,864],{"class":915},[902,1868,1404],{"class":1087},[902,1870,1302],{"class":915},[902,1872,937],{"class":929},[902,1874,1421],{"class":933},[902,1876,937],{"class":929},[902,1878,1312],{"class":915},[902,1880,1881],{"class":904,"line":1079},[902,1882,1430],{"class":1017},[902,1884,1885],{"class":904,"line":1433},[902,1886,1436],{"class":915},[902,1888,1889],{"class":904,"line":1439},[902,1890,1006],{"class":915},[1443,1892,1445],{},{"title":898,"searchDepth":943,"depth":943,"links":1894},[1895,1896,1897],{"id":889,"depth":943,"text":890},{"id":1138,"depth":943,"text":1139},{"id":1215,"depth":943,"text":1216},{},{"title":109,"description":1451},1780436294019]