codec

The codec built-in modules are available only inside a PubNub Function. They encode and decode HTTP Basic Authentication credentials, Base64 values, and query strings.

codec/auth

1const basicAuth = require('codec/auth');

basic

basic(username, password)

* required

Parameter	Description
username * Type: String	Basic Auth username.
password * Type: String	Basic Auth password.

Returns: an HTTP Basic Authentication header value.

1const basicAuth = require('codec/auth');
2console.log(basicAuth.basic('many', 'blocks')); // Basic: bWFueTpibG9ja3M=

codec/base64

1const base64Codec = require('codec/base64');

Method	Signature	Returns
btoa	btoa(unencoded)	unencoded encoded as Base64.
atob	atob(encoded)	Base64 string encoded decoded to text.
encodeString	encodeString(input)	input encoded to a URL-safe string.

1const base64Codec = require('codec/base64');
2console.log(base64Codec.btoa('hello')); // aGVsbG8=
3console.log(base64Codec.atob('aGVsbG8=')); // hello
4console.log(base64Codec.encodeString('+')); // _

codec/query_string

1const queryStringCodec = require('codec/query_string');

Method	Signature	Returns
parse	parse(queryString, defaults)	Object parsed from queryString, with defaults filled in for missing keys.
stringify	stringify(params)	Query string built from the params object.

1const queryStringCodec = require('codec/query_string');
2console.log(queryStringCodec.parse('a=5&b=10', { c: 15 })); // {a: 5, b: 10, c: 15}
3console.log(queryStringCodec.stringify({ a: 10, b: 15 })); // a=10&b=15

Related reference

• Modules and libraries. Every built-in module available inside a Function.
• crypto. Uses codec/base64 to prepare a key for hmac().