Class ImageAssets

Class for compiling information about image

Index

Constructors

Properties

imageBaseURL imageType mihoyoURL name url

Methods

fetchBuffer fetchStream deploy fromURL

Constructors

constructor

new ImageAssets(name: string, url?: string): ImageAssets
Classes for handling images
Parameters
- name: string
  Image name
- Optionalurl: string
  Image URL(Basically, no need to specify)
Returns ImageAssets

Properties

`Readonly`imageBaseURL

imageBaseURL: string

Image base URL

`Readonly`imageType

imageType: null | string

Image type

`Readonly`mihoyoURL

mihoyoURL: string

Image URL of mihoyo

`Readonly`name

name: string

Image name

`Readonly`url

url: string

Image URL

Methods

fetchBuffer

fetchBuffer(): Promise<Buffer>
Fetch image buffer

Returns Promise<Buffer>
Image buffer

fetchStream

fetchStream(highWaterMark?: number): Promise<ReadStream>
Fetch image stream
Parameters
- OptionalhighWaterMark: number
  HighWaterMark
Returns Promise<ReadStream>
Image stream

`Static`deploy

deploy(option: ClientOption): void
Classes for handling images
Parameters
- option: ClientOption
  Client option
Returns void

`Static`fromURL

fromURL(url: string): ImageAssets
Create a ImageAssets instance from the image URL
Parameters
- url: string
  Image URL
Returns ImageAssets
ImageAssets instance