IconPlugin.

Classes

IconPlugableClass

Extends PlugableClass.

new IconPlugableClass(): IconPlugableClass

Returns IconPlugableClass. Inherited from PlugableClass.constructor.

PropertyType
functionsFunctionRecord
icon(identified: Identified, opts?: JobOptions) => Promise<DataOrError<Element>>
optionsIconPluginOptions

Methods

install(definition, …ids): void | Errored

ParameterTypeDescription
definitionstring | Function | StringTuple
idsstring[]

Returns void | Errored. Inherited from PlugableClass.install.

toString(): string

Returns string. Inherited from PlugableClass.toString.

Interfaces

IconPluginOptions

Extends PluginOptions.

PropertyType
endpointPrefix?string
endpointRequest?string | EndpointRequest | StringRecord
icons?StringRecord

IconResponse

PropertyType
imageElement?HTMLImageElement
imgUrl?string
string?string
svgElement?SVGSVGElement
svgString?string

Variables

IconPlugin

const IconPlugin: IconPlugableClass

IconTag

const IconTag: "media-masher-icon"

Functions

iconPlug

iconPlug(identified, opts?): Promise<DataOrError<Element>>

ParameterTypeDescription
identifiedIdentified
opts?JobOptions

Returns Promise<DataOrError<Element>>.