deploy: 3db1b53

Author: will-lumley

data/documentation/faviconfinder.json

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

data/documentation/faviconfinder/favicon.json

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