Class ImageClient

Index

Constructors

Methods

asyncSignatureUrl deleteStyle get getExif getInfo getStream getStyle listStyle putStyle signatureUrl

Constructors

constructor

new ImageClient(options: ImageClientOptions): ImageClient
Parameters
- options: ImageClientOptions
Returns ImageClient
- Defined in index.d.ts:777

Methods

asyncSignatureUrl

asyncSignatureUrl(name: string, options?: SignatureUrlOptions): Promise<string>
Basically the same as signatureUrl, if refreshSTSToken is configured asyncSignatureUrl will refresh stsToken
Parameters
- name: string
- Optionaloptions: SignatureUrlOptions
Returns Promise<string>
- Defined in index.d.ts:831

deleteStyle

deleteStyle(
styleName: string,
options?: RequestOptions,
): Promise<NormalSuccessResponse>
todo
Parameters
- styleName: string
- Optionaloptions: RequestOptions
Returns Promise<NormalSuccessResponse>
- Defined in index.d.ts:821

get

get(
    name: string,
    file?: any,
    options?: ImageGetOptions,
): Promise<{ content: any; res: NormalSuccessResponse }>
Get an image from the image channel.
Parameters
- name: string
- Optionalfile: any
- Optionaloptions: ImageGetOptions
Returns Promise<{ content: any; res: NormalSuccessResponse }>
- Defined in index.d.ts:782

getExif

getExif(
name: string,
options?: RequestOptions,
): Promise<{ data: object; res: NormalSuccessResponse }>
Get a image exif info by image object name from the image channel.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<{ data: object; res: NormalSuccessResponse }>
- Defined in index.d.ts:792

getInfo

getInfo(
name: string,
options?: RequestOptions,
): Promise<{ data: object; res: NormalSuccessResponse }>
Get a image info and exif info by image object name from the image channel.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<{ data: object; res: NormalSuccessResponse }>
- Defined in index.d.ts:797

getStream

getStream(
name: string,
options?: ImageGetOptions,
): Promise<{ res: NormalSuccessResponse; stream: any }>
Get an image read stream.
Parameters
- name: string
- Optionaloptions: ImageGetOptions
Returns Promise<{ res: NormalSuccessResponse; stream: any }>
- Defined in index.d.ts:787

getStyle

getStyle(
name: string,
options?: RequestOptions,
): Promise<{ data: StyleData; res: NormalSuccessResponse }>
Get a style by name from the image channel.
Parameters
- name: string
- Optionaloptions: RequestOptions
Returns Promise<{ data: StyleData; res: NormalSuccessResponse }>
- Defined in index.d.ts:811

listStyle

listStyle(options?: RequestOptions): Promise<StyleData[]>
Get all styles from the image channel.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<StyleData[]>
- Defined in index.d.ts:816

putStyle

putStyle(
    name: string,
    style: string,
    options?: RequestOptions,
): Promise<{ data: object; res: NormalSuccessResponse }>
todo
Parameters
- name: string
- style: string
- Optionaloptions: RequestOptions
Returns Promise<{ data: object; res: NormalSuccessResponse }>
- Defined in index.d.ts:802

signatureUrl

signatureUrl(
name: string,
options?: { expires?: string; timeout?: string },
): string
Create a signature url for directly download.
Parameters
- name: string
- Optionaloptions: { expires?: string; timeout?: string }
Returns string
- Defined in index.d.ts:826