API.md

Iconographer

• Iconographer
  • static
    • .getIconDataURI(domain, [opts]) ⇒ Promise.<String>
    • .getIconDetails(domain, [param1]) ⇒ IconDetails
    • .getIconFilename(domain, [opts]) ⇒ String
    • .getResourcesPath() ⇒ String
    • .iconExists(domain) ⇒ Boolean
  • inner
    • ~IconOptions : Object
    • ~IconDetails : Object

Iconographer.getIconDataURI(domain, [opts]) ⇒ Promise.<String>

Get the Data URI for an icon

Kind: static method of Iconographer
Returns: Promise.<String> - A promise that resolves with the data URI

Param	Type	Description
domain	String	The domain to get an icon for
[opts]	IconOptions	Options

Iconographer.getIconDetails(domain, [param1]) ⇒ IconDetails

Get icon details for a domain

Kind: static method of Iconographer
Returns: IconDetails - Icon details

Param	Type	Description
domain	String | null	The domain to get icon details for. Pass null or undefined to automatically fetch the default icon
[param1]	IconOptions	Options for getting the icon

Iconographer.getIconFilename(domain, [opts]) ⇒ String

Get the filename of an icon for a domain

Kind: static method of Iconographer
Returns: String - The icon filename

Param	Type	Description
domain	String	The domain
[opts]	IconOptions	Options for getting the icon

Iconographer.getResourcesPath() ⇒ String

Return the path to the resources directory

Kind: static method of Iconographer
Returns: String - The path

Iconographer.iconExists(domain) ⇒ Boolean

Check if a unique icon exists for a domain

Kind: static method of Iconographer
Returns: Boolean - True if a unique icon exists, false if only the default icon

Param	Type	Description
domain	String	The domain to check for

Iconographer~IconOptions : Object

Kind: inner typedef of Iconographer
Properties

Name	Type	Description
[greyscale]	Boolean	Whether or not to request greyscale icons (default false)

Iconographer~IconDetails : Object

Kind: inner typedef of Iconographer
Properties

Name	Type	Description
filename	String	The full path of the icon file
isDefault	Boolean	Whether the icon is the default icon or not