quadrillion

A small TypeScript utility package for working with quadrillion-scale values.

What it does

This package exports a few tiny helpers built around the number one quadrillion (1_000_000_000_000_000).

• QUADRILLION: bigint constant for 1 quadrillion
• isAtLeastQuadrillion(value): checks whether a value is at least one quadrillion
• formatQuadrillions(value, fractionDigits?): formats a value as a human-readable number of quadrillions

Install

npm install quadrillion

Usage

import {
  QUADRILLION,
  formatQuadrillions,
  isAtLeastQuadrillion,
} from 'quadrillion'

console.log(QUADRILLION)
// 1000000000000000n

console.log(isAtLeastQuadrillion(1_500_000_000_000_000))
// true

console.log(formatQuadrillions(2_500_000_000_000_000n))
// "2.50 quadrillion"

API

QUADRILLION

const QUADRILLION: bigint

The bigint value 1000000000000000n.

isAtLeastQuadrillion(value)

function isAtLeastQuadrillion(value: number | bigint): boolean

Returns true when the input is greater than or equal to one quadrillion.

formatQuadrillions(value, fractionDigits?)

function formatQuadrillions(value: number | bigint, fractionDigits?: number): string

Formats the input as a number of quadrillions, such as "1.00 quadrillion" or "2.5000 quadrillion".

Development

npm install
npm run build
npm run typecheck
npm pack --dry-run

Publishing

This package is configured for public npm publishing:

npm publish --access public