Back to Jose

Function: encode()

docs/util/base64url/functions/encode.md

6.2.9997 B
Original Source

Function: encode()

šŸ’— Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

ā–ø encode(input): string

Encodes an input using Base64URL with no padding.

These functions are exported (as the base64url namespace) from the main 'jose' module entry point as well as from its subpath export 'jose/base64url'.

Parameters

ParameterTypeDescription
inputstring | Uint8ArrayInput to encode, as a string or as bytes. Strings are encoded as UTF-8 first.

Returns

string

The Base64URL encoded, unpadded, representation of the input.

Example

js
const encoded = jose.base64url.encode('Hello World!')