@accelint/constants
v0.4.0
Published
A collection of commonly used constant values for Accelint projects.
Readme
@accelint/constants
A collection of commonly used constant values for Accelint projects.
Installation
pnpm add @accelint/constantsUsage
Import from the main package or specific subpaths:
// Import all constants
import { DEFAULT_COORDINATE, HEX_REGEX } from '@accelint/constants';
// Import from subpaths
import { CSS_RGBA_LEGACY_REGEX, CSS_RGBA_MODERN_REGEX, HEX_REGEX } from '@accelint/constants/color';
import { DEFAULT_COORDINATE } from '@accelint/constants/coordinates';
import { DISTANCE_UNIT_SYMBOLS, METERS_PER_UNIT } from '@accelint/constants/units';Constants
Color
Regex patterns for parsing color strings in various formats.
HEX_REGEX
Matches hex color formats with or without the # prefix.
Supported formats:
- 3-character:
#RGBorRGB - 4-character:
#RGBAorRGBA - 6-character:
#RRGGBBorRRGGBB - 8-character:
#RRGGBBAAorRRGGBBAA
import { HEX_REGEX } from '@accelint/constants/color';
HEX_REGEX.test('#FF8040'); // true
HEX_REGEX.test('FF8040'); // true
HEX_REGEX.test('#F84'); // true
HEX_REGEX.test('#FF804080'); // trueCSS_RGBA_LEGACY_REGEX
Matches legacy comma-separated CSS color syntax (CSS Color Module Level 3).
Supported formats:
rgb(r, g, b)rgba(r, g, b, a)- Supports integers and percentages for RGB values
- Supports decimals and percentages for alpha
import { CSS_RGBA_LEGACY_REGEX } from '@accelint/constants/color';
CSS_RGBA_LEGACY_REGEX.test('rgb(255, 128, 64)'); // true
CSS_RGBA_LEGACY_REGEX.test('rgba(255, 128, 64, 0.5)'); // true
CSS_RGBA_LEGACY_REGEX.test('rgb(100%, 50%, 25%)'); // trueCSS_RGBA_MODERN_REGEX
Matches modern space-separated CSS color syntax (CSS Color Module Level 4).
Supported formats:
rgb(r g b)rgb(r g b / a)- Supports integers and percentages for RGB values
- Supports decimals and percentages for alpha
import { CSS_RGBA_MODERN_REGEX } from '@accelint/constants/color';
CSS_RGBA_MODERN_REGEX.test('rgb(255 128 64)'); // true
CSS_RGBA_MODERN_REGEX.test('rgb(255 128 64 / 0.5)'); // true
CSS_RGBA_MODERN_REGEX.test('rgb(100% 50% 25%)'); // trueCoordinates
DEFAULT_COORDINATE
Default empty coordinate value [NaN, NaN].
Using [0, 0] as a default is incorrect because it represents a real location in the Atlantic Ocean known as "Null Island" (where the prime meridian meets the equator in the Gulf of Guinea).
import { DEFAULT_COORDINATE } from '@accelint/constants/coordinates';
const userLocation = coordinates ?? DEFAULT_COORDINATE;Units
Distance units shared by the geo, formatters, and map packages. All objects are readonly (as const).
DISTANCE_UNIT_SYMBOLS
Maps each distance unit name to its display symbol: { kilometers: 'km', meters: 'm', nauticalmiles: 'NM', miles: 'mi', feet: 'ft' }.
DistanceUnit
Union of the unit names: 'kilometers' | 'meters' | 'nauticalmiles' | 'miles' | 'feet'.
DistanceUnitSymbol
Union of the display symbols: 'km' | 'm' | 'NM' | 'mi' | 'ft'.
DISTANCE_UNIT_BY_SYMBOL
The inverse of DISTANCE_UNIT_SYMBOLS: maps each symbol back to its unit name, for parsing user input such as "NM".
METERS_PER_UNIT
Exact number of meters in one of each unit: { kilometers: 1000, meters: 1, nauticalmiles: 1852, miles: 1609.344, feet: 0.3048 }. Divide a distance in meters by the factor to convert it to that unit.
import {
DISTANCE_UNIT_BY_SYMBOL,
DISTANCE_UNIT_SYMBOLS,
METERS_PER_UNIT,
type DistanceUnit,
type DistanceUnitSymbol,
} from '@accelint/constants/units';
const units: DistanceUnit = 'nauticalmiles';
DISTANCE_UNIT_SYMBOLS[units]; // 'NM'
DISTANCE_UNIT_BY_SYMBOL['NM']; // 'nauticalmiles'
343556 / METERS_PER_UNIT[units]; // ~185.5 (nautical miles)
343556 / METERS_PER_UNIT.kilometers; // ~343.6
const symbol: DistanceUnitSymbol = DISTANCE_UNIT_SYMBOLS.feet; // 'ft'License
Apache-2.0
