Skip to content

Class: Base64

Constructors

Constructor

ts
new Base64(): Base64;

Returns

Base64

Methods

decode()

Call Signature

ts
decode(
   encode: string,
   encoding: BufferEncoding,
   strict: true): string;

Base64 decode a previously encoded string or Buffer.

Parameters
ParameterType
encodestring
encodingBufferEncoding
stricttrue
Returns

string

Call Signature

ts
decode(
   encode: string,
   encoding: undefined,
   strict: true): string;

Base64 decode a previously encoded string or Buffer.

Parameters
ParameterType
encodestring
encodingundefined
stricttrue
Returns

string

Call Signature

ts
decode(
   encode: string,
   encoding?: BufferEncoding,
   strict?: false): null | string;

Base64 decode a previously encoded string or Buffer.

Parameters
ParameterType
encodestring
encoding?BufferEncoding
strict?false
Returns

null | string

Call Signature

ts
decode(encode: Buffer, encoding?: BufferEncoding): string;

Base64 decode a previously encoded string or Buffer.

Parameters
ParameterType
encodeBuffer
encoding?BufferEncoding
Returns

string


encode()

Call Signature

ts
encode(arrayBuffer: ArrayBuffer | Buffer | SharedArrayBuffer): string;

Base64 encode Buffer or string

Parameters
ParameterType
arrayBufferArrayBuffer | Buffer | SharedArrayBuffer
Returns

string

Call Signature

ts
encode(data: string, encoding?: BufferEncoding): string;

Base64 encode Buffer or string

Parameters
ParameterType
datastring
encoding?BufferEncoding
Returns

string


urlDecode()

Call Signature

ts
urlDecode(
   encode: string,
   encoding: BufferEncoding,
   strict: true): string;

Base64 URL decode a previously encoded string or Buffer. (RFC 4648)

Parameters
ParameterType
encodestring
encodingBufferEncoding
stricttrue
Returns

string

Call Signature

ts
urlDecode(
   encode: string,
   encoding: undefined,
   strict: true): string;

Base64 URL decode a previously encoded string or Buffer. (RFC 4648)

Parameters
ParameterType
encodestring
encodingundefined
stricttrue
Returns

string

Call Signature

ts
urlDecode(
   encode: string,
   encoding?: BufferEncoding,
   strict?: false): null | string;

Base64 URL decode a previously encoded string or Buffer. (RFC 4648)

Parameters
ParameterType
encodestring
encoding?BufferEncoding
strict?false
Returns

null | string

Call Signature

ts
urlDecode(encode: Buffer, encoding?: BufferEncoding): string;

Base64 URL decode a previously encoded string or Buffer. (RFC 4648)

Parameters
ParameterType
encodeBuffer
encoding?BufferEncoding
Returns

string


urlEncode()

Call Signature

ts
urlEncode(arrayBuffer: ArrayBuffer | Buffer | SharedArrayBuffer): string;

Base64 encode Buffer or string to be URL safe. (RFC 4648)

Parameters
ParameterType
arrayBufferArrayBuffer | Buffer | SharedArrayBuffer
Returns

string

Call Signature

ts
urlEncode(data: string, encoding?: BufferEncoding): string;

Base64 encode Buffer or string to be URL safe. (RFC 4648)

Parameters
ParameterType
datastring
encoding?BufferEncoding
Returns

string