C.Decode - Data Decoding Methods

​

C.Decode.base64()

​

C.Decode.base64(val: string, resultEnc: string = 'utf8'): string | Buffer | undefined

Performs Base64 decoding of the given string.

Returns a string or Buffer, depending on the resultEnc value.

Examples

​

To decode an encoded field and return the decoded value as a Buffer, use:

C.Decode.base64(encoded, 'buffer')

C.Decode.gzip()

​

C.Decode.gzip(value: Buffer | string, encoding?: BufferEncoding) : string

Gunzips the supplied value.

Example

​

To decode a hostname field which had been encoded using hex, run:

C.Decode.gzip(hostname, 'hex')

C.Decode.hex()

​

C.Decode.hex(val: string): number

Performs hex to number conversion. Returns NaN if value cannot be converted to a number.

C.Decode.inflate()

​

C.Decode.inflate(value: Buffer | string, encoding: BufferEncoding = 'base64', isRaw = false): string

Inflates the supplied value.

Examples

​

To Base64-decode and inflate the value contained in a _raw field, you can use:

C.Decode.inflate(_raw)

To additionally specify a different encoding to use, run:

C.Decode.inflate(_raw, 'hex')

C.Decode.mime()

​

C.Decode.mime(val: string): string

Decode string that has been encoded with MIME RFC 2047 standard. This standard is frequently used in email subject lines within logs to handle non-ASCII characters.

Examples

​

To decode a MIME-encoded string using the Quoted-Printable format, typically seen when the non-ASCII content is mostly readable text, use:

 C.Decode.mime('=?UTF-8?Q?R=C3=A9sum=C3=A9?=') // Returns: 'Résumé'

To decode a MIME-encoded string using the Base64 format, often used when the non-ASCII content is complex or binary data, use:

C.Decode.mime('=?UTF-8?B?Q2Fmw6k=?=') // Returns: 'Café'.

### `C.Decode.uri()`

```js
C.Decode.uri(val: string): string

Performs URI-decoding of the given string.

C.Encode - Data Encoding Methods

​

C.Encode.base64()

​

C.Encode.base64(val: string | Buffer, trimTrailEq: boolean = false, encoding?: BufferEncoding): string

Returns a Base64 representation of the given string or Buffer.

Examples

​

To Base64-encode the username field, and remove the trailing =, use:

C.Encode.base64(username, true)

To Base64-encode the hexValue field, where the value of the field is a hex string:

C.Encode.base64('4672616e6b7575757575', undefined, 'hex')

C.Encode.deflate()

​

C.Encode.deflate(value: Buffer | string, encoding: BufferEncoding | 'none' = 'base64', toRaw = false): string | Buffer

Deflates and optionally Base64-encodes the supplied value.

Examples

​

To deflate and hex-decode the value provided in an inflated field, run:

C.Encode.deflate(inflated, 'hex')

C.Encode.gzip()

​

C.Encode.gzip(value: Buffer | string, encoding?: string) : string | Buffer

Gzips, and optionally Base64-encodes, the supplied value.

Examples

​

To encode the hostname field, for example using hex encoding, run:

C.Encode.gzip(hostname, 'hex')

C.Encode.hex()

​

C.Encode.hex(val: string | number): string

Rounds the number to an integer and returns its hex representation (lowercase). If a string is provided, it will be parsed into a number or NaN.

C.Encode.mime()

​

C.Encode.mime(val: string, encoding: string = 'Q', maxLineLength: number = 0, charset?: string): string

Encode a string with MIME RFC 2047 standard. This method is used to prepare header values that contain non-ASCII characters for transport, such as email subject lines.

Examples

​

To encode a MIME-encoded string using the Quoted-Printable format, use:

C.Encode.mime(_raw)

To encode a MIME-encoded string using the Base64 format, use:

C.Encode.mime(_raw, `B`)

To encode a string using Quoted-Printable and apply line folding to ensure no encoded line exceeds 20 characters:

C.Encode.mime('A much longer subject line with a non-ascii character: Español', 'Q', 20)
// Returns `=?UTF-8?Q?A_much_longer_subject_line_with_a_non-ascii_characte?= \n =?UTF-8?Q?r:_Espa=C3=B1ol?=`

C.Encode.uri()

​

C.Encode.uri(val: string): string

Returns the URI-encoded representation of the given string.