OutputEncoding Property

The encoding type to apply to the output data.

Syntax

 publickeycrypto.getOutputEncoding([callback])
 publickeycrypto.setOutputEncoding( outputEncoding, [callback])

Possible Values

  0 (cetDefault), 
  1 (cetBinary), 
  2 (cetBase64), 
  3 (cetCompact), 
  4 (cetJSON)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getOutputEncoding([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setOutputEncoding([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Use this property to specify the encoding type to apply to the protected data.


cetDefault	`0`	The default encoding type in current circumstances. This depends on the operation and the type of the key being used.
cetBinary	`1`	Raw binary encoding (no encoding)
cetBase64	`2`	Base64 encoding (armouring)
cetCompact	`3`	JSON compact encoding
cetJSON	`4`	JSON standard encoding

Data Type

Integer