kraken/docs/code/README.md

Plug into the power and speed of Kraken.io Image Optimizer

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

*   [Kraken][1]
    *   [Parameters][2]
    *   [upload][3]
        *   [Parameters][4]
    *   [url][5]
        *   [Parameters][6]
    *   [userStatus][7]
        *   [Parameters][8]
*   [AxiosOptions][9]
*   [KrakenApiData][10]
    *   [toJson][11]
*   [KrakenApiList][12]
*   [KrakenAuth][13]
*   [KrakenResponse][14]
*   [KrakenUploadData][15]

## Kraken

[src/kraken.js:85-156][16]

This class describes a Kraken-io API

### Parameters

*   `keyOrAuth` **[string][17]** Kraken API key
*   `secret` **[string][17]** Kraken API secret (optional, default `null`)

### upload

[src/kraken.js:113-131][18]

Upload image to Kraken.io and optimize it

#### Parameters

*   `options` **[object][19]** Kraken options for uploaded image
*   `cb` **[Function][20]** \=null (optional, default `null`)

Returns **[Promise][21]<[KrakenResponse][22]>** 

### url

[src/kraken.js:139-143][23]

Optimize image from URL

#### Parameters

*   `options` **[object][19]** Kraken options for url
*   `cb` **[Function][20]** \=null Callback (optional, default `null`)

Returns **[Promise][21]** 

### userStatus

[src/kraken.js:151-155][24]

Get user status

#### Parameters

*   `cb` **[Function][20]** Callback (optional, default `null`)

Returns **[Promise][21]** 

## AxiosOptions

[src/lib/AxiosOptions.js:6-22][25]

Provides options processing for axios

## KrakenApiData

[src/lib/KrakenApiData.js:6-23][26]

Provides kraken API data processing

### toJson

[src/lib/KrakenApiData.js:20-22][27]

Convert API Data to JSON string

Returns **[string][17]** 

## KrakenApiList

[src/lib/KrakenApiList.js:9-25][28]

Provides Kraken API methods list

## KrakenAuth

[src/lib/KrakenAuth.js:6-16][29]

Provides Kraken.io credentials for API

## KrakenResponse

[src/lib/KrakenResponse.js:6-14][30]

Just a container for Kraken API response data

## KrakenUploadData

[src/lib/KrakenUploadData.js:22-98][31]

**Extends FormData**

KrakenUploadData processing a data for uploading.

[1]: #kraken

[2]: #parameters

[3]: #upload

[4]: #parameters-1

[5]: #url

[6]: #parameters-2

[7]: #userstatus

[8]: #parameters-3

[9]: #axiosoptions

[10]: #krakenapidata

[11]: #tojson

[12]: #krakenapilist

[13]: #krakenauth

[14]: #krakenresponse

[15]: #krakenuploaddata

[16]: https://github.com/kraken-io/kraken-node/blob/0b4bbcefcd070e8431660f20a2b6a95db38caa13/src/kraken.js#L85-L156 "Source code on GitHub"

[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

[18]: https://github.com/kraken-io/kraken-node/blob/0b4bbcefcd070e8431660f20a2b6a95db38caa13/src/kraken.js#L113-L131 "Source code on GitHub"

[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function

[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise

[22]: #krakenresponse

[23]: https://github.com/kraken-io/kraken-node/blob/0b4bbcefcd070e8431660f20a2b6a95db38caa13/src/kraken.js#L139-L143 "Source code on GitHub"

[24]: https://github.com/kraken-io/kraken-node/blob/0b4bbcefcd070e8431660f20a2b6a95db38caa13/src/kraken.js#L151-L155 "Source code on GitHub"

[25]: https://github.com/kraken-io/kraken-node/blob/0b4bbcefcd070e8431660f20a2b6a95db38caa13/src/lib/AxiosOptions.js#L6-L22 "Source code on GitHub"

[26]: https://github.com/kraken-io/kraken-node/blob/0b4bbcefcd070e8431660f20a2b6a95db38caa13/src/lib/KrakenApiData.js#L6-L23 "Source code on GitHub"

[27]: https://github.com/kraken-io/kraken-node/blob/0b4bbcefcd070e8431660f20a2b6a95db38caa13/src/lib/KrakenApiData.js#L20-L22 "Source code on GitHub"

[28]: https://github.com/kraken-io/kraken-node/blob/0b4bbcefcd070e8431660f20a2b6a95db38caa13/src/lib/KrakenApiList.js#L9-L25 "Source code on GitHub"

[29]: https://github.com/kraken-io/kraken-node/blob/0b4bbcefcd070e8431660f20a2b6a95db38caa13/src/lib/KrakenAuth.js#L6-L16 "Source code on GitHub"

[30]: https://github.com/kraken-io/kraken-node/blob/0b4bbcefcd070e8431660f20a2b6a95db38caa13/src/lib/KrakenResponse.js#L6-L14 "Source code on GitHub"

[31]: https://github.com/kraken-io/kraken-node/blob/0b4bbcefcd070e8431660f20a2b6a95db38caa13/src/lib/KrakenUploadData.js#L22-L98 "Source code on GitHub"