@handy-common-utils/misc-utils

@handy-common-utils/misc-utils

Miscellaneous utilities

How to use

First add it as a dependency:

npm install @handy-common-utils/misc-utils

Then you can use it in the code:

import { shortBase64UrlFromUInt32 } from '@handy-common-utils/misc-utils';

const urlSafeBase64 = shortBase64UrlFromUInt32(12345);

API

@handy-common-utils/misc-utils

@handy-common-utils/misc-utils

Table of contents

Functions

• base64FromUInt32
• base64UrlFromUInt32
• shortBase64FromUInt32
• shortBase64UrlFromUInt32
• urlSafe

Functions

base64FromUInt32

▸ base64FromUInt32<T>(ui32): Exclude<T, number> | string

Encode an unsigned 32-bit integer into BASE64 string.

Type parameters

Name	Type
T	extends undefined | null | number

Parameters

Name	Type	Description
ui32	T	A number which could also be null or undefined. It must be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an unsigned 32-bit integer.

Returns

Exclude<T, number> | string

BASE64 string representing the integer input, or the original input if it is null or undefined.

---

base64UrlFromUInt32

▸ base64UrlFromUInt32<T>(ui32, replacements?): Exclude<T, number> | string

Encode an unsigned 32-bit integer into URL/path safe BASE64 string.

Type parameters

Name	Type
T	extends undefined | null | number

Parameters

Name	Type	Default value	Description
ui32	T	undefined	A number which could also be null or undefined. It must be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an unsigned 32-bit integer.
replacements	string	'_-='	A string containing replacement characters for "/", "+", and "=". If omitted, default value of '_-=' would be used.

Returns

Exclude<T, number> | string

URL/path safe BASE64 string representing the integer input, or the original input if it is null or undefined.

---

shortBase64FromUInt32

▸ shortBase64FromUInt32<T>(ui32): Exclude<T, number> | string

Encode an unsigned 32-bit integer into BASE64 string without trailing '='.

Type parameters

Name	Type
T	extends undefined | null | number

Parameters

Name	Type	Description
ui32	T	A number which could also be null or undefined. It must be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an unsigned 32-bit integer.

Returns

Exclude<T, number> | string

BASE64 string without trailing '=' representing the integer input, or the original input if it is null or undefined.

---

shortBase64UrlFromUInt32

▸ shortBase64UrlFromUInt32<T>(ui32, replacements?): Exclude<T, number> | string

Encode an unsigned 32-bit integer into URL/path safe BASE64 string without trailling '='.

Type parameters

Name	Type
T	extends undefined | null | number

Parameters

Name	Type	Default value	Description
ui32	T	undefined	A number which could also be null or undefined. It must be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an unsigned 32-bit integer.
replacements	string	'_-'	A string containing replacement characters for "/" and "+". If omitted, default value of '_-' would be used.

Returns

Exclude<T, number> | string

URL/path safe BASE64 string without trailing '=' representing the integer input, or the original input if it is null or undefined.

---

urlSafe

▸ urlSafe<T>(base64Input, replacements?): T

Make a "normal" (BASE64) string URL/path safe.

Type parameters

Name	Type
T	extends undefined | null | string

Parameters

Name	Type	Default value	Description
base64Input	T	undefined	A (BASE64) string which could be null or undefined.
replacements	string	'_-='	A string containing replacement characters for "/", "+", and "=". If omitted, default value of '_-=' would be used.

Returns

T

URL/path safe version of the (BASE64) input string, or the original input if it is null or undefined.