Class IconApi

Index

Constructors

Methods

[kGetIconBlob] create getIconUrl

Constructors

constructor

new IconApi(opts): IconApi
Parameters
- opts: {
      getMediaBaseUrl: (() => Promise<string>);
      iconDataStore: DataStore<"config",
          | "translation"
          | "projectSettings"
          | "preset"
          | "icon"
          | "field"
          | "deviceInfo">;
      iconDataType: DataType<DataStore<"config",
          | "translation"
          | "projectSettings"
          | "preset"
          | "icon"
          | "field"
          | "deviceInfo">, SQLiteTableWithColumns<{}>, "icon", {}, {}>;
  }
  - getMediaBaseUrl: (() => Promise<string>)
    - (): Promise<string>
      Returns Promise<string>
  - iconDataStore: DataStore<"config",
        | "translation"
        | "projectSettings"
        | "preset"
        | "icon"
        | "field"
        | "deviceInfo">
  - iconDataType: DataType<DataStore<"config",
        | "translation"
        | "projectSettings"
        | "preset"
        | "icon"
        | "field"
        | "deviceInfo">, SQLiteTableWithColumns<{}>, "icon", {}, {}>
Returns IconApi

Methods

[kGetIconBlob]

[kGetIconBlob](iconId, opts): Promise<Buffer>
Parameters
- iconId: string
- opts: BitmapOpts | SvgOpts
Returns Promise<Buffer>

create

create(icon): Promise<{}>
Parameters
- icon: {
      name: string;
      variants: ((BitmapOpts | SvgOpts) & {
          blob: Buffer;
      })[];
  }
  - name: string
  - variants: ((BitmapOpts | SvgOpts) & {
    blob: Buffer;
    })[]
Returns Promise<{}>

getIconUrl

getIconUrl(iconId, opts): Promise<string>
Parameters
- iconId: string
- opts: BitmapOpts | SvgOpts
Returns Promise<string>