deploy: 98ca9e5

Author: will-lumley

data/documentation/faviconfinder.json

@@ -1 +1 @@
-{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/FaviconFinder\/documentation\/FaviconFinder"]]},"sections":[],"abstract":[{"type":"codeVoice","code":"Favicon"},{"text":" represents the downloaded favicon image along with metadata.","type":"text"}],"relationshipsSections":[{"identifiers":["doc:\/\/FaviconFinder\/s8SendableP"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"topicSections":[{"anchor":"Initializers","identifiers":["doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/init(url:)"],"title":"Initializers","generated":true},{"anchor":"Instance-Properties","identifiers":["doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/image","doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/url"],"title":"Instance Properties","generated":true}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Favicon"}],"languages":["swift"]}]},{"content":[{"text":"Overview","type":"heading","level":2,"anchor":"overview"},{"inlineContent":[{"type":"text","text":"This struct encapsulates the favicon’s image and the URL from which it was retrieved."},{"type":"text","text":" "},{"type":"text","text":"When initialized, it automatically downloads the favicon from the provided "},{"type":"codeVoice","code":"FaviconURL"},{"type":"text","text":"."}],"type":"paragraph"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Properties:"}]},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"code":"image","type":"codeVoice"},{"text":": The downloaded favicon image, which may be ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":" if the download fails.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"code":"url","type":"codeVoice"},{"type":"text","text":": The URL from which the favicon was retrieved, encapsulated in a "},{"code":"FaviconURL","type":"codeVoice"},{"type":"text","text":"."}]}]}],"type":"unorderedList"}]},{"content":[{"inlineContent":[{"type":"text","text":"Lifecycle:"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"code":"init(url: FaviconURL)","type":"codeVoice"},{"type":"text","text":": Initializes the "},{"code":"Favicon","type":"codeVoice"},{"type":"text","text":" by downloading the image at the given "},{"code":"FaviconURL","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}],"type":"unorderedList"}]}],"type":"unorderedList"},{"name":"Throws","content":[{"inlineContent":[{"type":"text","text":"Throws "},{"type":"codeVoice","code":"FaviconError.invalidImage"},{"type":"text","text":" if the image cannot be downloaded or parsed"}],"type":"paragraph"}],"type":"aside","style":"note"}],"kind":"content"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon"},"variants":[{"paths":["\/documentation\/faviconfinder\/favicon"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"Favicon","modules":[{"name":"FaviconFinder"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Favicon"}],"externalID":"s:13FaviconFinder0A0V","symbolKind":"struct","navigatorTitle":[{"text":"Favicon","kind":"identifier"}],"role":"symbol","roleHeading":"Structure"},"references":{"doc://FaviconFinder/documentation/FaviconFinder/Favicon/url":{"role":"symbol","abstract":[{"text":"The url of the .ico or HTML page, of where the favicon was found","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13FaviconFinder0A3URLV","kind":"typeIdentifier","text":"FaviconURL"}],"url":"\/documentation\/faviconfinder\/favicon\/url","kind":"symbol","type":"topic","title":"url","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/url"},"doc://FaviconFinder/documentation/FaviconFinder/Favicon/init(url:)":{"title":"init(url:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FaviconURL","preciseIdentifier":"s:13FaviconFinder0A3URLV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"role":"symbol","abstract":[{"text":"Upon instantiation, we will attempt to download the image at the provided location","type":"text"}],"kind":"symbol","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/init(url:)","url":"\/documentation\/faviconfinder\/favicon\/init(url:)","type":"topic"},"doc://FaviconFinder/s8SendableP":{"identifier":"doc:\/\/FaviconFinder\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://FaviconFinder/documentation/FaviconFinder/Favicon/image":{"url":"\/documentation\/faviconfinder\/favicon\/image","role":"symbol","abstract":[{"text":"The actual image. Can be ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":" if  the download fails","type":"text"}],"type":"topic","title":"image","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/image","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"image"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13FaviconFinder0A5ImageV","kind":"typeIdentifier","text":"FaviconImage"},{"kind":"text","text":"?"}]},"doc://FaviconFinder/documentation/FaviconFinder/Favicon":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Favicon"}],"abstract":[{"code":"Favicon","type":"codeVoice"},{"text":" represents the downloaded favicon image along with metadata.","type":"text"}],"url":"\/documentation\/faviconfinder\/favicon","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon","navigatorTitle":[{"kind":"identifier","text":"Favicon"}],"kind":"symbol","type":"topic","role":"symbol","title":"Favicon"},"doc://FaviconFinder/documentation/FaviconFinder":{"kind":"symbol","abstract":[],"role":"collection","title":"FaviconFinder","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder","type":"topic","url":"\/documentation\/faviconfinder"}}}
+{"sections":[],"abstract":[{"type":"codeVoice","code":"Favicon"},{"type":"text","text":" represents the downloaded favicon image along with metadata."}],"schemaVersion":{"major":0,"patch":0,"minor":3},"topicSections":[{"identifiers":["doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/init(url:)"],"title":"Initializers","anchor":"Initializers","generated":true},{"identifiers":["doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/image","doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/url"],"title":"Instance Properties","anchor":"Instance-Properties","generated":true}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/FaviconFinder\/s8SendableP"],"title":"Conforms To","kind":"relationships"}],"metadata":{"externalID":"s:13FaviconFinder0A0V","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Favicon","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Favicon"}],"modules":[{"name":"FaviconFinder"}],"role":"symbol","symbolKind":"struct","title":"Favicon","roleHeading":"Structure"},"hierarchy":{"paths":[["doc:\/\/FaviconFinder\/documentation\/FaviconFinder"]]},"identifier":{"url":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Favicon"}],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Overview","level":2,"anchor":"overview"},{"type":"paragraph","inlineContent":[{"text":"This struct encapsulates the favicon’s image and the URL from which it was retrieved.","type":"text"},{"text":" ","type":"text"},{"text":"When initialized, it automatically downloads the favicon from the provided ","type":"text"},{"code":"FaviconURL","type":"codeVoice"},{"text":".","type":"text"}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Properties:"}]},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"codeVoice","code":"image"},{"text":": The downloaded favicon image, which may be ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":" if the download fails.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"code":"url","type":"codeVoice"},{"text":": The URL from which the favicon was retrieved, encapsulated in a ","type":"text"},{"code":"FaviconURL","type":"codeVoice"},{"text":".","type":"text"}]}]}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Lifecycle:","type":"text"}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"code":"init(url: FaviconURL)","type":"codeVoice"},{"text":": Initializes the ","type":"text"},{"code":"Favicon","type":"codeVoice"},{"text":" by downloading the image at the given ","type":"text"},{"code":"FaviconURL","type":"codeVoice"},{"text":".","type":"text"}]}]}]}]}]},{"type":"aside","style":"note","name":"Throws","content":[{"inlineContent":[{"type":"text","text":"Throws "},{"type":"codeVoice","code":"FaviconError.invalidImage"},{"type":"text","text":" if the image cannot be downloaded or parsed"}],"type":"paragraph"}]}]}],"variants":[{"paths":["\/documentation\/faviconfinder\/favicon"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://FaviconFinder/documentation/FaviconFinder/Favicon":{"identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon","kind":"symbol","title":"Favicon","navigatorTitle":[{"kind":"identifier","text":"Favicon"}],"url":"\/documentation\/faviconfinder\/favicon","abstract":[{"code":"Favicon","type":"codeVoice"},{"type":"text","text":" represents the downloaded favicon image along with metadata."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Favicon"}],"type":"topic","role":"symbol"},"doc://FaviconFinder/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/FaviconFinder\/s8SendableP"},"doc://FaviconFinder/documentation/FaviconFinder/Favicon/init(url:)":{"kind":"symbol","type":"topic","url":"\/documentation\/faviconfinder\/favicon\/init(url:)","title":"init(url:)","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/init(url:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"url","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13FaviconFinder0A3URLV","text":"FaviconURL","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"abstract":[{"type":"text","text":"Upon instantiation, we will attempt to download the image at the provided location"}]},"doc://FaviconFinder/documentation/FaviconFinder/Favicon/image":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"image","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13FaviconFinder0A5ImageV","text":"FaviconImage","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"image","role":"symbol","url":"\/documentation\/faviconfinder\/favicon\/image","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/image","type":"topic","abstract":[{"type":"text","text":"The actual image. Can be "},{"type":"codeVoice","code":"nil"},{"type":"text","text":" if  the download fails"}],"kind":"symbol"},"doc://FaviconFinder/documentation/FaviconFinder":{"identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder","url":"\/documentation\/faviconfinder","kind":"symbol","title":"FaviconFinder","abstract":[],"type":"topic","role":"collection"},"doc://FaviconFinder/documentation/FaviconFinder/Favicon/url":{"type":"topic","title":"url","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13FaviconFinder0A3URLV","text":"FaviconURL"}],"role":"symbol","abstract":[{"type":"text","text":"The url of the .ico or HTML page, of where the favicon was found"}],"kind":"symbol","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/url","url":"\/documentation\/faviconfinder\/favicon\/url"}}}

data/documentation/faviconfinder/favicon.json

@@ -1 +1 @@
-{"kind":"symbol","variants":[{"paths":["\/documentation\/faviconfinder\/favicon\/image"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/image","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/FaviconFinder\/documentation\/FaviconFinder","doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"image"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13FaviconFinder0A5ImageV","text":"FaviconImage","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/FaviconImage"},{"kind":"text","text":"?"}],"platforms":["macOS"]}]}],"metadata":{"externalID":"s:13FaviconFinder0A0V5imageAA0A5ImageVSgvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"image"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13FaviconFinder0A5ImageV","text":"FaviconImage"},{"kind":"text","text":"?"}],"symbolKind":"property","modules":[{"name":"FaviconFinder"}],"roleHeading":"Instance Property","title":"image","role":"symbol"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"The actual image. Can be ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":" if  the download fails","type":"text"}],"references":{"doc://FaviconFinder/documentation/FaviconFinder/Favicon/image":{"url":"\/documentation\/faviconfinder\/favicon\/image","role":"symbol","abstract":[{"text":"The actual image. Can be ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":" if  the download fails","type":"text"}],"type":"topic","title":"image","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/image","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"image"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13FaviconFinder0A5ImageV","kind":"typeIdentifier","text":"FaviconImage"},{"kind":"text","text":"?"}]},"doc://FaviconFinder/documentation/FaviconFinder/Favicon":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Favicon"}],"abstract":[{"code":"Favicon","type":"codeVoice"},{"text":" represents the downloaded favicon image along with metadata.","type":"text"}],"url":"\/documentation\/faviconfinder\/favicon","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon","navigatorTitle":[{"kind":"identifier","text":"Favicon"}],"kind":"symbol","type":"topic","role":"symbol","title":"Favicon"},"doc://FaviconFinder/documentation/FaviconFinder/FaviconImage":{"kind":"symbol","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/FaviconImage","abstract":[{"code":"FaviconImage","type":"codeVoice"},{"text":" is a platform-agnostic struct that encapsulates the data and","type":"text"},{"text":" ","type":"text"},{"text":"platform-specific image representation of a favicon.","type":"text"}],"title":"FaviconImage","navigatorTitle":[{"text":"FaviconImage","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"FaviconImage","kind":"identifier"}],"url":"\/documentation\/faviconfinder\/faviconimage","type":"topic","role":"symbol"},"doc://FaviconFinder/documentation/FaviconFinder":{"kind":"symbol","abstract":[],"role":"collection","title":"FaviconFinder","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder","type":"topic","url":"\/documentation\/faviconfinder"}}}
+{"sections":[],"kind":"symbol","metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"image","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13FaviconFinder0A5ImageV","text":"FaviconImage","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","roleHeading":"Instance Property","modules":[{"name":"FaviconFinder"}],"externalID":"s:13FaviconFinder0A0V5imageAA0A5ImageVSgvp","title":"image","symbolKind":"property"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"image","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13FaviconFinder0A5ImageV","text":"FaviconImage","kind":"typeIdentifier","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/FaviconImage"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/FaviconFinder\/documentation\/FaviconFinder","doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon"]]},"abstract":[{"type":"text","text":"The actual image. Can be "},{"code":"nil","type":"codeVoice"},{"type":"text","text":" if  the download fails"}],"identifier":{"url":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/image","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/faviconfinder\/favicon\/image"]}],"references":{"doc://FaviconFinder/documentation/FaviconFinder/Favicon":{"identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon","kind":"symbol","title":"Favicon","navigatorTitle":[{"kind":"identifier","text":"Favicon"}],"url":"\/documentation\/faviconfinder\/favicon","abstract":[{"code":"Favicon","type":"codeVoice"},{"type":"text","text":" represents the downloaded favicon image along with metadata."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Favicon"}],"type":"topic","role":"symbol"},"doc://FaviconFinder/documentation/FaviconFinder/FaviconImage":{"kind":"symbol","abstract":[{"type":"codeVoice","code":"FaviconImage"},{"text":" is a platform-agnostic struct that encapsulates the data and","type":"text"},{"text":" ","type":"text"},{"text":"platform-specific image representation of a favicon.","type":"text"}],"identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/FaviconImage","title":"FaviconImage","url":"\/documentation\/faviconfinder\/faviconimage","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"FaviconImage"}],"navigatorTitle":[{"kind":"identifier","text":"FaviconImage"}],"role":"symbol"},"doc://FaviconFinder/documentation/FaviconFinder":{"identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder","url":"\/documentation\/faviconfinder","kind":"symbol","title":"FaviconFinder","abstract":[],"type":"topic","role":"collection"},"doc://FaviconFinder/documentation/FaviconFinder/Favicon/image":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"image","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13FaviconFinder0A5ImageV","text":"FaviconImage","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"image","role":"symbol","url":"\/documentation\/faviconfinder\/favicon\/image","identifier":"doc:\/\/FaviconFinder\/documentation\/FaviconFinder\/Favicon\/image","type":"topic","abstract":[{"type":"text","text":"The actual image. Can be "},{"type":"codeVoice","code":"nil"},{"type":"text","text":" if  the download fails"}],"kind":"symbol"}}}