@barchart/common-js/types/lang/mask.d.ts

Library of common JavaScript utilities

/**
 * Returns an empty bit mask.
 *
 * @public
 * @returns {number}
 */
export function getEmpty(): number;
/**
 * Adds a single-bit item to an existing bit mask.
 *
 * @public
 * @param {number} existing
 * @param {number} itemToAdd
 * @returns {number}
 */
export function add(existing: number, itemToAdd: number): number;
/**
 * Removes a single-bit item from an existing bit mask.
 *
 * @public
 * @param {number} existing
 * @param {number} itemToRemove
 * @returns {number}
 */
export function remove(existing: number, itemToRemove: number): number;
/**
 * Indicates whether an existing bit mask contains a single-bit item.
 *
 * @public
 * @param {number} existing
 * @param {number} itemToCheck
 * @returns {boolean}
 */
export function has(existing: number, itemToCheck: number): boolean;
/**
 * Indicates whether a value can be used as a single-bit mask item.
 *
 * @public
 * @param {number} itemToCheck
 * @returns {boolean}
 */
export function checkItem(itemToCheck: number): boolean;