hazybits-js

hazybits-js is JavaScript SDK that can be used in both nodejs and browser environments to access HazyBits infrastructure.

Read more about the features.

API Reference

Classes

HazyBitsClient

Typedefs

HazyConnectCallback : function

Callback signature for HazyBitsClient.connect method.

HazyBitsClient

Kind: global class

• HazyBitsClient
  • new HazyBitsClient([entryUrl])
  • .connect(authToken, [callback]) ⇒ undefined
  • .start(base64) ⇒ undefined
  • .threshold(base64, [callback]) ⇒ undefined
  • .rotate(base64, [callback]) ⇒ undefined
  • .ocr(base64, [callback]) ⇒ undefined
  • .convert(blob, [callback])

new HazyBitsClient([entryUrl])

Creates Hazy Bits client object.

Param	Type	Default	Description
[entryUrl]	string	"https://api.hazybits.com"	Hazy Bits API entry point URL.

hazyClient.connect(authToken, [callback]) ⇒ undefined

Connects to Hazy Bits infrastructure and creates new session.

Kind: instance method of HazyBitsClient

Param	Type	Description
authToken	string	Authentication token.
[callback]	HazyConnectCallback	Completion callback.

hazyClient.start(base64) ⇒ undefined

Starts processing workflow using provided image as input.

Kind: instance method of HazyBitsClient

Param	Description
base64	Image in base64 form.

hazyClient.threshold(base64, [callback]) ⇒ undefined

Performs threshold operation over provided image.

Kind: instance method of HazyBitsClient

Param	Type	Description
base64		Image in base64 form.
[callback]	function	Completion callback.

hazyClient.rotate(base64, [callback]) ⇒ undefined

Performs rotate operation over provided image.

Kind: instance method of HazyBitsClient

Param	Type	Description
base64		Image in base64 form.
[callback]	function	Completion callback.

hazyClient.ocr(base64, [callback]) ⇒ undefined

Starts OCR processing over provided image.

Kind: instance method of HazyBitsClient

Param	Type	Description
base64		Image in base64 form.
[callback]	function	Completion callback.

hazyClient.convert(blob, [callback])

Retrieves specified blob.

Kind: instance method of HazyBitsClient

Param	Type	Description
blob		Blob to retrieve.
[callback]	function	Completion callback.

HazyConnectCallback : function

Callback signature for HazyBitsClient.connect method.

Kind: global typedef

Param	Type	Description
err	object	Connection error, if any.
client	HazyBitsClient	Initialized HazyBits client instance.

---

© 2016 HazyBits. Documented by jsdoc-to-markdown.