haolib is designed to be a comprehensive library for building different types of applications, it is a meta-framework to solve as many problems as possible.
haolib considered to be a monolith. It is a single package.
Still, if you do not need some features (for example, you most likely wouldn’t need Web API features if you are building
a Kafkaconsumer), you can use only the parts you need.
See installation for more details.
haolib is designed to be as implementation-agnostic as possible. It is not tied to any specific database, web framework, or any other dependency.
haolib is always SOTA. Of course, we will keep a feature implementation if for some reason it becomes legacy, but the vector of development and adding new features is always to be as SOTA as possible.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"haolib","colors":{"primary":"#00CC8B","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/haovc/0wE8Yr8kVpcifXqh/logo/light.svg?fit=max\u0026auto=format\u0026n=0wE8Yr8kVpcifXqh\u0026q=85\u0026s=ab331eb38826d2275ee0f1bfa81b1292","dark":"https://mintcdn.com/haovc/0wE8Yr8kVpcifXqh/logo/dark.svg?fit=max\u0026auto=format\u0026n=0wE8Yr8kVpcifXqh\u0026q=85\u0026s=d6a25aab715c9680da37ca664d199ba0"},"favicon":"/favicon.svg","appearance":{},"background":{"decoration":"windows","color":{"light":"#FAFAFA","dark":"#0A0A0A"}},"navbar":{"links":[],"primary":{"type":"github","href":"https://github.com/hao-vc/haolib"}},"footer":{"socials":{"website":"https://hao.vc","github":"https://github.com/hao-vc/haolib","telegram":"https://t.me/hao_vc"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"haovc","hasAudioNarration":false,"actualSubdomain":"haovc","customDomains":["lib.hao.vc"],"gitSource":{"type":"github","owner":"hao-vc","repo":"haolib","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e908a8fc07c2afd3cfff","collectionId":"0eabe8ab-d95e-4b19-8f61-9c3a951b2145","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e908a8fc07c2afd3cfff:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Configs","count":9},{"language":"default","tag":"Models","count":7},{"language":"default","tag":"Base Entities","count":6},{"language":"default","tag":"Entrypoints","count":6},{"language":"default","tag":"Batches","count":5},{"language":"default","tag":"Getting Started","count":5},{"language":"default","tag":"Endpoint Examples","count":4},{"language":"default","tag":"Database","count":3},{"language":"default","tag":"Specification","count":3},{"language":"default","tag":"Transactions","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"essentials/philosophy","slug":"/essentials/philosophy","pageMetadata":{"title":"Philosophy","description":"The philosophy behind haolib","icon":"lightbulb","href":"/essentials/philosophy"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"The philosophy behind haolib\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsx(_components.p,{children:`This might be useless for you if you are a person of practice rather than a person of theory.`})}),`\n`,_jsx(Heading,{level:`2`,id:`the-philosophy-of-haolib`,children:`The philosophy of haolib`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`haolib is designed to be a comprehensive library for building different types of applications, it is a `,_jsxs(_components.strong,{children:[_jsx(`a`,{href:`https://en.wikipedia.org/wiki/Meta_(prefix)`,children:`meta`}),`-`,_jsx(`a`,{href:`https://en.wikipedia.org/wiki/Software_framework`,children:`framework`})]}),` to solve as many problems as possible.`]}),`\n`,_jsxs(_components.li,{children:[`haolib considered to be a monolith. It is a single package.\nStill, if you do not need some features (for example, you most likely wouldn’t need `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/Web_API`,children:`Web API`}),` features if you are building\na `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/Apache_Kafka`,children:`Kafka`}),` `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/Producer%E2%80%93consumer_problem`,children:`consumer`}),`), you can use only the parts you need.\nSee `,_jsx(_components.a,{href:`/essentials/installation`,children:`installation`}),` for more details.`]}),`\n`,_jsx(_components.li,{children:`haolib is designed to be as implementation-agnostic as possible. It is not tied to any specific database, web framework, or any other dependency.`}),`\n`,_jsx(_components.li,{children:`haolib is always SOTA. Of course, we will keep a feature implementation if for some reason it becomes legacy, but the vector of development and adding new features is always to be as SOTA as possible.`}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Philosophy","description":"The philosophy behind haolib","icon":"lightbulb","href":"/essentials/philosophy"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"The philosophy of haolib","slug":"the-philosophy-of-haolib","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"haovc","siteName":"haolib","title":"Philosophy - haolib","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"essentials/philosophy.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The philosophy behind haolib\">\u003cmeta data-mint-head name=\"application-name\" content=\"haolib\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/haovc/69n6zL6Pqa5awUoq/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/haovc/69n6zL6Pqa5awUoq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/haovc/69n6zL6Pqa5awUoq/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/haovc/69n6zL6Pqa5awUoq/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/haovc/69n6zL6Pqa5awUoq/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/haovc/69n6zL6Pqa5awUoq/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/haovc/69n6zL6Pqa5awUoq/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/haovc/69n6zL6Pqa5awUoq/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/haovc/69n6zL6Pqa5awUoq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Philosophy - haolib\">\u003cmeta data-mint-head property=\"og:description\" content=\"The philosophy behind haolib\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"haolib\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://lib.hao.vc/essentials/philosophy\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://haovc.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Philosophy\u0026amp;description=The+philosophy+behind+haolib\u0026amp;theme=4df91545dec309206e104afa\u0026amp;signature=0f9d0db2ca69cf601d384b24e1cacff5cabc3e19c9b2024de28d8fdf18ff3476\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Philosophy - haolib\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The philosophy behind haolib\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://haovc.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Philosophy\u0026amp;description=The+philosophy+behind+haolib\u0026amp;theme=4df91545dec309206e104afa\u0026amp;signature=0f9d0db2ca69cf601d384b24e1cacff5cabc3e19c9b2024de28d8fdf18ff3476\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/haovc/69n6zL6Pqa5awUoq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"haolib\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00CC8B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://lib.hao.vc/essentials/philosophy\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/essentials/philosophy.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://lib.hao.vc/#organization\",\"name\":\"haolib\",\"url\":\"https://lib.hao.vc\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/haovc/0wE8Yr8kVpcifXqh/logo/light.svg?fit=max\u0026auto=format\u0026n=0wE8Yr8kVpcifXqh\u0026q=85\u0026s=ab331eb38826d2275ee0f1bfa81b1292\"}},{\"@type\":\"WebSite\",\"@id\":\"https://lib.hao.vc#website\",\"name\":\"haolib\",\"url\":\"https://lib.hao.vc\",\"publisher\":{\"@id\":\"https://lib.hao.vc/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://lib.hao.vc/essentials/philosophy#webpage\",\"url\":\"https://lib.hao.vc/essentials/philosophy\",\"name\":\"Philosophy\",\"description\":\"The philosophy behind haolib\",\"isPartOf\":{\"@id\":\"https://lib.hao.vc#website\"},\"breadcrumb\":{\"@id\":\"https://lib.hao.vc/essentials/philosophy#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://lib.hao.vc/essentials/philosophy#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://lib.hao.vc/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Philosophy\",\"item\":\"https://lib.hao.vc/essentials/philosophy\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://lib.hao.vc/essentials/philosophy#article\",\"headline\":\"Philosophy\",\"name\":\"Philosophy\",\"description\":\"The philosophy behind haolib\",\"url\":\"https://lib.hao.vc/essentials/philosophy\",\"mainEntityOfPage\":{\"@id\":\"https://lib.hao.vc/essentials/philosophy#webpage\"},\"publisher\":{\"@id\":\"https://lib.hao.vc/#organization\"},\"isPartOf\":{\"@id\":\"https://lib.hao.vc#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"haolib\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"haolib","nav":{"global":null,"products":[{"product":"READ THIS FIRST","icon":"book","description":"Read this first before you start using haolib","groups":[{"group":"Getting Started","icon":"rocket","pages":[{"title":"READ THIS NO MATTER WHAT, SERIOUSLY!!!","icon":"warning","href":""},{"title":"What is next?","icon":"question","href":"/essentials/whatisnext"},{"title":"Project Map","icon":"map","href":"/essentials/projectmap"},{"title":"Installation","description":"How to install haolib","icon":"download","href":"/essentials/installation"},{"title":"Philosophy","icon":"lightbulb","href":"/essentials/philosophy"}]}]},{"product":"Security","icon":"shield-check","description":"Authentication, JWT, encryption, and password management","pages":[{"title":"Security","href":"/security/introduction"}]},{"product":"Database","icon":"database","description":"Database models, specifications, and transactions","pages":[{"title":"Database","href":"/database/introduction"}]},{"product":"Observability","icon":"chart-line","description":"Logging, monitoring, and observability","pages":[{"title":"Observability","href":"/observability/introduction"}]},{"product":"Core","icon":"cube","description":"Core modules: batches, configs, dependencies, entities, entrypoints, enums, exceptions, and utils","pages":[{"title":"Core","href":"/batches/introduction"}]},{"product":"Web","icon":"globe","description":"Web-specific features including idempotency","pages":[{"title":"Web","href":"/web/introduction"}]},{"product":"API Reference","icon":"code","description":"API documentation and endpoint examples","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"basePath":"","title":"Philosophy - haolib","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":[],"chunks":[]}