utils

A collection of utilities that are used by brick-city packages.

Table of Contents

- Installation
- Usage
- Support
- Contributing
- License

Installation

``
npm install --save @brick-city/utils
`




Usage

- acHelper A little abort controller helper
- asciiCaseInsensitiveRegex Pass a string, return a regex that matches ascii letters with case insensitivity, does not use /i
- arrayToString Nicely format an array for display
- deepFreeze Deep freeze an object and avoid buffers
- isPlainObject Check if an object is a plain object
- isPlainObjectEmpty Check if an object is a plain object, and is empty
- isRegex Check if the passed value is a regular expression
- isUndefinedOrNull Check for an undefined or null value
- lucidePick A utility for filtering and selecting Lucide icons by category, name, or tags
- mssqlCdcUpdateMaskToBooleanArray Converts an mssql change data capture update mask to an array of boolean
- mssqlCdcUpdateMaskToBitArray Converts an mssql change data capture update mask to an array of bits
- noopLogger A pino structured no-op logger
- traceLogger Generates trace messages, and posts them to the provided logger
- zeroPaddedBinary Nicely format a number as a binary

$3

acHelper & acHelperNoSignal are abort controller helpers. They simplify some of the repetitive code when consuming AbortSignals and creating AbortControllers.
acHelper requires a signal, acHelperNoSignal does not. Hopefully this code example makes sense

`javascript
import { acHelper } from '@brick-city/utils';

async myAsyncFunction ({signal, options})
{
const controller = acHelper({ signal, timeout:50000, abortCallback: () => {
console.log('Abort signal received');
// Additional cleanup or error handling logic here
}});

// Any abort signals received from caller on signal will be passed down to 'fetch'
// myAsyncFunction will also time out after 50000, and the downstream fetch will be aborted

try {
const fetchPromise = fetch('https://api.example.com/data', {
signal: controller.signal,
...options
});

try {
await someOtherAsyncThings ();
const response = await fetchPromise;
}
catch (error){
controller.abort(); // This will abort the fetch
}

} catch (error) {
console.error('An error occurred:', error);
} finally {
controller.abort(); // Abort the request if it hasn't completed yet
}
}

myAsyncFunction({ signal: new AbortController().signal, options: { method: 'GET' } });
`




$3

From a passed string, returns a regex with special characters escaped and ASCII letters matched
to both upper and lower case letters.

` javascript
import { acHelper } from '@brick-city/utils';

const regex = asciiCaseInsensitiveRegex("Hello*World");
console.log(regex); // Output: /[Hh][Ee][Ll][Ll][Oo]\*[Ww][Oo][Rr][Ll][Dd]/
console.log(regex.test("hElLo*woRLd")); // Output: true

asciiCaseInsensitiveRegex({}) // throws new TypeError('Expecting a string')
asciiCaseInsensitiveRegex({a:0}) // throws new TypeError('Expecting a string')
asciiCaseInsensitiveRegex(null) // throws new TypeError('Expecting a string')
asciiCaseInsensitiveRegex(undefined) // throws new TypeError('Expecting a string')

`




$3

arrayToString displays an array as you would expect it to look in code. If the element is undefined, only a comma is returned, if it is a string its wrapped in quotes. Simply calls .toString on each element

Throws a type error if passed something other than an array.

`javascript
import { arrayToString } from '@brick-city/utils';

arrayToString([]) // []
arrayToString([,]) // [ ,]
arrayToString([,,]) // [ , ,]
arrayToString([5,,5]) // [ 5, , 5]
arrayToString([1, 'abc', 5]) // [ 1, 'abc', 5]

`




$3

deepFreeze takes an object and recursively walks down the object's own properties and deepFreeze(s) any plain objects it finds, and then freezes the object. Buffers and other non-plain objects are skipped. This was a drawback of other "deepFreeze" type functions which are tripped up by Buffers. Returns a reference to the originally passed object.

`javascript
import { deepFreeze } from '@brick-city/utils';

deepFreeze(object)

`




$3

isPlainObject returns a boolean that indicates if the object is a plain object.

`javascript
import { isPlainObject } from '@brick-city/utils';

isPlainObject({}) // true
isPlainObject({a:0}) // true
isPlainObject(null) // false
isPlainObject(()=>{}) // false
isPlainObject(7) // false
isPlainObject( new Object() ); //true
isPlainObject( Object.create(null) ); //true

`




$3

isPlainObjectEmpty returns a boolean that indicates if the object is a plain object and it is empty.

`javascript
import { isPlainObjectEmpty } from '@brick-city/utils';

isPlainObjectEmpty({}) // true
isPlainObjectEmpty({a:0}) // false
isPlainObjectEmpty(null) // false
isPlainObjectEmpty(()=>{}) // false
isPlainObjectEmpty(7) // false
isPlainObjectEmpty( new Object() ); //true
isPlainObjectEmpty( Object.create(null) ); //true

`




$3

isRegex returns a boolean that indicates if the object is a regular expression.

`javascript
import { isRegex } from '@brick-city/utils';

isRegex( new RegExp('') ); //true
isRegex( new RegExp('ab+c') ); //true
isRegex( new RegExp(/.+/ ) ); //true
isRegex({}) // false
isRegex({a:0}) // false
isRegex(null) // false
isRegex(()=>{}) // false
isRegex(7) // false
isRegex( new Object() ); //false
isRegex( Object.create(null) ); //false

`




$3

isUndefinedOrNull returns a boolean that indicates if the value passed is either undefined or null.

`javascript
import { isPlainObjectEmpty } from '@brick-city/utils';

isUndefinedOrNull({}) // false
isUndefinedOrNull({a:0}) // false
isUndefinedOrNull(null) // true
isUndefinedOrNull(undefined) // true
isUndefinedOrNull(()=>{}) // false
isUndefinedOrNull(7) // false

`




$3

lucidePick is a utility for filtering and selecting Lucide icons by category, name, or tags. It uses a category-based approach for metadata loading to improve performance and reduce memory usage. Upon creation of a new picker, the callbacks for categoryCallback and iconListCallback will be called after the initial filter and category are set.

`javascript
import { lucidePick } from '@brick-city/utils';

// Create a picker instance
const picker = lucidePick({
// Callback for category list updates
categoryCallback: (categories) => {
// Handle category list updates
// categories is an array of { category, count } objects
// Note: '*' category is always first, other categories are sorted alphabetically
console.log(categories);
},

// Callback for icon list updates
iconListCallback: (icons) => {
// Handle icon list updates
// icons is an array of icon metadata objects
console.log(icons);
},

// Optional initial category
initialCategory: 'arrows',

// Optional initial filter
initialFilter: 'direction'
});

// Methods available on the picker instance
picker.setCategory('design'); // Filter by category
picker.setCategory('*'); // Show all categories (wildcard - shows all icons)
picker.setFilter('chart'); // Filter by tag or name (case-insensitive)
picker.clearFilter(); // Clear all filters
picker.getIcon('ArrowUp'); // Get metadata for a specific icon
picker.getActiveCategory(); // Get the currently active category
picker.getActiveFilter(); // Get the currently active filter string
`




$3

mssqlCdcUpdateMaskToBooleanArray takes a mssql change data capture update mask, and returns a boolean array which signifies which column ordinal bits are set. The first column ordinal in mssql change data capture is 1, so the zeroth array element is empty.

`javascript
import { mssqlCdcUpdateMaskToBooleanArray:updateMaskToBoolean } from '@brick-city/util';

updateMaskToBoolean(Buffer.from([0b00000010]); // [, false, true, false, false, false, false, false, false]
updateMaskToBoolean(Buffer.from([0b01000000]); // [, false, false, false, false, false, false, true, false]
updateMaskToBoolean(Buffer.from([0b00000001, 0b11111111]); // [, true, true, true, true, true, true, true, true, true, false, false, false, false, false, false, false, true, false, true, false, false, false, false, false ]
updateMaskToBoolean(Buffer.from([0b00000101, 0b00000001, 0b11111111]); // [,
// true, true, true, true, true, true, true, true,
// true, false, false, false, false, false, false, false,
// true, false, true, false, false, false, false, false,
// ]
// Notice the bytes are reversed, the last bytes bits appear first
`





$3

mssqlCdcUpdateMaskToBitArray takes a mssql change data capture update mask, and returns a bit array which signifies which column ordinal bits are set. The first column ordinal in mssql change data capture is 1, so the zeroth array element is empty.

`javascript
import { mssqlCdcUpdateMaskTobitArray:updateMaskToBit } from '@brick-city/utils';

updateMaskToBit(Buffer.from([0b00000010]); // [, 0, 1, 0, 0, 0, 0, 0, 0]
updateMaskToBit(Buffer.from([0b01000000]); // [, 0, 0, 0, 0, 0, 0, 1, 0]
updateMaskToBit(Buffer.from([0b00000001, 0b11111111]); // [, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0]
updateMaskToBit(Buffer.from([0b00000101, 0b00000001, 0b11111111]); // [, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 0, 0]
// Notice the bytes are reversed, the last bytes bits appear first
`




$3

noopLogger is an object with all pino logger logging methods defined, but does nothing.

`javascript
import { noopLogger } from '@brick-city/util';

// Now use it in places where a pino logger is needed, but
// none was passed.

`




$3

Pass a pinot styled logger (needs a 'trace' method, and isLevelEnabled method) to this function and it
will return a function that logs a trace message. If the logger does not have a trace method, or the
log level is not 'trace', it will return a function that does nothing.

The trace message will include the file name, line number, column number, function name, and method name.

`javascript
import { traceLogger } from '@brick-city/utils';

trace = traceLogger(pinoInstance);

// Now drop these wherever you need to trace the logic

trace()

`




$3

zeroPaddedBinary returns the integer as a binary string padded with zeros to a length of multiples of 8, and prefixed with '0b'. Throws with a TypeError if the value passed is not a number. The value is rounded down to an integer if it is a float.

`javascript
import { zeroPaddedBinary } from '@brick-city/utils';

zeroPaddedBinary({}) // throws new TypeError('Expecting a number')
zeroPaddedBinary({a:0}) // throws new TypeError('Expecting a number')
zeroPaddedBinary(null) // throws new TypeError('Expecting a number')
zeroPaddedBinary(undefined) // throws new TypeError('Expecting a number')
zeroPaddedBinary(262) // '0b0000000100000110'
zeroPaddedBinary(7) // '0b00000111'

``

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

License

MIT License