diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..19e460f --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ + +MIT License + +Copyright (c) 2024 Layered + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/src/index.ts b/src/index.ts index c0df8bc..e8021c2 100644 --- a/src/index.ts +++ b/src/index.ts @@ -208,12 +208,22 @@ export function sanitizeUrl(url: string | URL, options?: SanitizeUrlOptions): UR return toURL } +interface UrlInfo { + originalUrl: string + url: string + hostname: string + domain: string + subdomain: string | null + handle: string | null + providerId: string | null +} + /** * Extract information from a URL, such as the domain, handle, or provider ID (e.g. YouTube channel ID, Twitter handle, and more). * @param url - URL to extract info from * @returns */ -export function urlInfo(url: string | URL) { +export function urlInfo(url: string | URL): UrlInfo { const originalUrl = url url = sanitizeUrl(url) @@ -281,13 +291,13 @@ export function urlInfo(url: string | URL) { } return { - originalUrl, + originalUrl: originalUrl.toString(), url: url.toString(), hostname: url.hostname, domain: parsedDomain.domain, subdomain: parsedDomain.subdomain, - handle, - providerId, + handle: handle || null, + providerId: providerId || null, } }