deploy: e946896

Author: will-lumley

data/documentation/faviconfinder.json

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

data/documentation/faviconfinder/favicon.json

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