Class ImageClient

Hierarchy

ImageClient

Index

Constructors

constructor

Methods

Constructors

constructor

new ImageClient(options: ImageClientOptions): ImageClient

- Defined in index.d.ts:676
Parameters
- options: ImageClientOptions
Returns ImageClient

Methods

deleteStyle

deleteStyle(styleName: string, options?: RequestOptions): Promise<NormalSuccessResponse>

- Defined in index.d.ts:720
todo

Parameters
- styleName: string
- Optional options: RequestOptions
Returns Promise<NormalSuccessResponse>

get

get(name: string, file?: any, options?: ImageGetOptions): Promise<{ content: any; res: NormalSuccessResponse }>

- Defined in index.d.ts:681
Get an image from the image channel.

Parameters
- name: string
- Optional file: any
- Optional options: ImageGetOptions
Returns Promise<{ content: any; res: NormalSuccessResponse }>

getExif

getExif(name: string, options?: RequestOptions): Promise<{ data: object; res: NormalSuccessResponse }>

- Defined in index.d.ts:691
Get a image exif info by image object name from the image channel.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<{ data: object; res: NormalSuccessResponse }>

getInfo

getInfo(name: string, options?: RequestOptions): Promise<{ data: object; res: NormalSuccessResponse }>

- Defined in index.d.ts:696
Get a image info and exif info by image object name from the image channel.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<{ data: object; res: NormalSuccessResponse }>

getStream

getStream(name: string, options?: ImageGetOptions): Promise<{ res: NormalSuccessResponse; stream: any }>

- Defined in index.d.ts:686
Get an image read stream.

Parameters
- name: string
- Optional options: ImageGetOptions
Returns Promise<{ res: NormalSuccessResponse; stream: any }>

getStyle

getStyle(name: string, options?: RequestOptions): Promise<{ data: StyleData; res: NormalSuccessResponse }>

- Defined in index.d.ts:710
Get a style by name from the image channel.

Parameters
- name: string
- Optional options: RequestOptions
Returns Promise<{ data: StyleData; res: NormalSuccessResponse }>

listStyle

listStyle(options?: RequestOptions): Promise<StyleData[]>

- Defined in index.d.ts:715
Get all styles from the image channel.

Parameters
- Optional options: RequestOptions
Returns Promise<StyleData[]>

putStyle

putStyle(name: string, style: string, options?: RequestOptions): Promise<{ data: object; res: NormalSuccessResponse }>

- Defined in index.d.ts:701
todo

Parameters
- name: string
- style: string
- Optional options: RequestOptions
Returns Promise<{ data: object; res: NormalSuccessResponse }>

signatureUrl

signatureUrl(name: string, options?: { expires?: string; timeout?: string }): string

- Defined in index.d.ts:725
Create a signature url for directly download.

Parameters
- name: string
- Optional options: { expires?: string; timeout?: string }
  - Optional expires?: string
  - Optional timeout?: string
Returns string

Generated using TypeDoc