Use throwing variants when invalid URLs should interrupt the request immediately.
Use safe variants when you want a single return shape throughout the call chain.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"google-maps-link-parser","colors":{"primary":"#0f766e","light":"#ccfbf1","dark":"#134e4a"},"logo":{"light":"https://mintcdn.com/google-maps-link-parser/AymcIeZcm5ECLKAs/logo/light.svg?fit=max\u0026auto=format\u0026n=AymcIeZcm5ECLKAs\u0026q=85\u0026s=0da5cfda2f16965b7c084c1178d6f3b6","dark":"https://mintcdn.com/google-maps-link-parser/AymcIeZcm5ECLKAs/logo/dark.svg?fit=max\u0026auto=format\u0026n=AymcIeZcm5ECLKAs\u0026q=85\u0026s=336e7c21dd924e2d04987a4b5657bb2d"},"favicon":"https://mintcdn.com/google-maps-link-parser/AymcIeZcm5ECLKAs/favicon.svg?fit=max\u0026auto=format\u0026n=AymcIeZcm5ECLKAs\u0026q=85\u0026s=b5c35997b9faea1b157101ebf1f88e78","navbar":{"links":[{"href":"https://github.com/kdcokenny/google-maps-link-parser","label":"GitHub"},{"href":"https://www.npmjs.com/package/google-maps-link-parser","label":"npm"}],"primary":{"type":"button","label":"Quick start","href":"/getting-started/quick-start"}},"footer":{"socials":{"github":"https://github.com/kdcokenny/google-maps-link-parser"}},"seo":{"metatags":{"og:title":"google-maps-link-parser","og:description":"Bun-first Google Maps URL parsing, short-link unfurling, and optional enrichment for public shared URLs.","twitter:card":"summary_large_image"}},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"google-maps-link-parser","hasAudioNarration":false,"actualSubdomain":"google-maps-link-parser","customDomains":["gmlp.kdco.dev"],"gitSource":{"type":"github","owner":"kdcokenny","repo":"google-maps-link-parser","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae94a64d111843d72bc94bc:success","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Docs","count":16},{"language":"default","tag":"Guides","count":4},{"language":"default","tag":"API Reference","count":3},{"language":"default","tag":"Concepts","count":3},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Examples","count":2},{"language":"default","tag":"Project","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/errors","slug":"/api-reference/errors","pageMetadata":{"title":"Errors","description":"Typed error classes and when to use them.","href":"/api-reference/errors"},"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: \"Typed error classes and when to use them.\"\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={code:`code`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`error-classes`,children:`Error classes`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`GoogleMapsUrlError`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`EmptyInputError`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`InvalidGoogleMapsUrlError`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`DisallowedHostnameError`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`UnsupportedGoogleMapsUrlError`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`RedirectLimitError`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`NetworkTimeoutError`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`NetworkRequestError`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`GoogleProviderError`})}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`guidance`,children:`Guidance`}),`\n`,_jsx(_components.p,{children:`Use throwing variants when invalid URLs should interrupt the request immediately.\nUse safe variants when you want a single return shape throughout the call chain.`})]})}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":"Errors","description":"Typed error classes and when to use them.","href":"/api-reference/errors"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Error classes","slug":"error-classes","depth":2,"children":[]},{"title":"Guidance","slug":"guidance","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"google-maps-link-parser","siteName":"google-maps-link-parser","title":"google-maps-link-parser","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-19T02:20:36.329Z","originalFileLocation":"api-reference/errors.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=\"Typed error classes and when to use them.\">\u003cmeta data-mint-head name=\"application-name\" content=\"google-maps-link-parser\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/google-maps-link-parser/db3nSatg3mMEssDM/_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/google-maps-link-parser/db3nSatg3mMEssDM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/google-maps-link-parser/db3nSatg3mMEssDM/_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/google-maps-link-parser/db3nSatg3mMEssDM/_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/google-maps-link-parser/db3nSatg3mMEssDM/_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/google-maps-link-parser/db3nSatg3mMEssDM/_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/google-maps-link-parser/db3nSatg3mMEssDM/_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/google-maps-link-parser/db3nSatg3mMEssDM/_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/google-maps-link-parser/db3nSatg3mMEssDM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"google-maps-link-parser\">\u003cmeta data-mint-head property=\"og:description\" content=\"Bun-first Google Maps URL parsing, short-link unfurling, and optional enrichment for public shared URLs.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"google-maps-link-parser\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://gmlp.kdco.dev/api-reference/errors\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://google-maps-link-parser.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Errors\u0026amp;description=Typed+error+classes+and+when+to+use+them.\u0026amp;theme=77c96d55b8ac8811cdbf0c0e\u0026amp;signature=5999ef5abc673defd8a592f1811c7feb9fa4bdee7238320e5c25d5ba2a0f9935\">\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=\"google-maps-link-parser\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Bun-first Google Maps URL parsing, short-link unfurling, and optional enrichment for public shared URLs.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://google-maps-link-parser.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Errors\u0026amp;description=Typed+error+classes+and+when+to+use+them.\u0026amp;theme=77c96d55b8ac8811cdbf0c0e\u0026amp;signature=5999ef5abc673defd8a592f1811c7feb9fa4bdee7238320e5c25d5ba2a0f9935\">\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/google-maps-link-parser/db3nSatg3mMEssDM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"google-maps-link-parser\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0f766e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://gmlp.kdco.dev/api-reference/errors\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/errors.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://gmlp.kdco.dev/#organization\",\"name\":\"google-maps-link-parser\",\"url\":\"https://gmlp.kdco.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/google-maps-link-parser/AymcIeZcm5ECLKAs/logo/light.svg?fit=max\u0026auto=format\u0026n=AymcIeZcm5ECLKAs\u0026q=85\u0026s=0da5cfda2f16965b7c084c1178d6f3b6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://gmlp.kdco.dev#website\",\"name\":\"google-maps-link-parser\",\"url\":\"https://gmlp.kdco.dev\",\"publisher\":{\"@id\":\"https://gmlp.kdco.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://gmlp.kdco.dev/api-reference/errors#webpage\",\"url\":\"https://gmlp.kdco.dev/api-reference/errors\",\"name\":\"Errors\",\"description\":\"Typed error classes and when to use them.\",\"dateModified\":\"2026-03-19T02:20:36.329Z\",\"isPartOf\":{\"@id\":\"https://gmlp.kdco.dev#website\"},\"breadcrumb\":{\"@id\":\"https://gmlp.kdco.dev/api-reference/errors#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://gmlp.kdco.dev/api-reference/errors#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://gmlp.kdco.dev/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Errors\",\"item\":\"https://gmlp.kdco.dev/api-reference/errors\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://gmlp.kdco.dev/api-reference/errors#article\",\"headline\":\"Errors\",\"name\":\"Errors\",\"description\":\"Typed error classes and when to use them.\",\"url\":\"https://gmlp.kdco.dev/api-reference/errors\",\"mainEntityOfPage\":{\"@id\":\"https://gmlp.kdco.dev/api-reference/errors#webpage\"},\"dateModified\":\"2026-03-19T02:20:36.329Z\",\"publisher\":{\"@id\":\"https://gmlp.kdco.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://gmlp.kdco.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"google-maps-link-parser\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"google-maps-link-parser\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/errors.md","siteName":"google-maps-link-parser","nav":{"global":{},"tabs":[{"tab":"Docs","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":""},{"title":"Installation","href":"/getting-started/installation"},{"title":"Quick start","href":"/getting-started/quick-start"}]},{"group":"Concepts","pages":[{"title":"Parsing model","href":"/concepts/parsing-model"},{"title":"Parse vs unfurl vs enrich","href":"/concepts/parse-vs-unfurl-vs-enrich"},{"title":"Security model","href":"/concepts/security-model"}]},{"group":"Guides","pages":[{"title":"Parse coordinates","href":"/guides/parse-coordinates"},{"title":"Handle short links","href":"/guides/handle-short-links"},{"title":"Raw artifacts","href":"/guides/raw-artifacts"},{"title":"Error handling","href":"/guides/error-handling"}]},{"group":"Examples","pages":[{"title":"Node usage","href":"/examples/node-usage"},{"title":"Browser usage","href":"/examples/browser-usage"}]},{"group":"API Reference","pages":[{"title":"API overview","description":"The main public functions and how they fit together.","href":"/api-reference/overview"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Types","description":"Key public types exposed by the package.","href":"/api-reference/types"}]},{"group":"Project","pages":[{"title":"Releases","href":"/releases"}]}]}]},"basePath":"","title":"google-maps-link-parser","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":[],"chunks":[]}