@hg-argo/demo-core-lib

Zero-dependency utilities for numeric ranges and random integers — the primitives on which @hg-argo/demo-game-lib is built.

Installation

pnpm

pnpm add @hg-argo/demo-core-lib

npm

npm install @hg-argo/demo-core-lib

randomInt

Returns a random integer between min and max, inclusive on both ends.

import { randomInt } from '@hg-argo/demo-core-lib'

randomInt(1, 6)   // simulates a dice roll → 1, 2, 3, 4, 5, or 6
randomInt(0, 0)   // always 0

Range

A plain interface representing a closed numeric interval [min, max].

import type { Range } from '@hg-argo/demo-core-lib'

const percentage: Range = { min: 0, max: 100 }

contains

Returns true if a value falls within the range (inclusive).

import { contains } from '@hg-argo/demo-core-lib'

contains({ min: 1, max: 10 }, 5)   // true
contains({ min: 1, max: 10 }, 0)   // false
contains({ min: 1, max: 10 }, 10)  // true

clamp

Clamps a value so it never falls outside the range.

import { clamp } from '@hg-argo/demo-core-lib'

clamp({ min: 0, max: 100 }, 120)  // 100
clamp({ min: 0, max: 100 }, -5)   // 0
clamp({ min: 0, max: 100 }, 42)   // 42

size

Returns the number of integers in the range.

import { size } from '@hg-argo/demo-core-lib'

size({ min: 1, max: 10 })   // 10
size({ min: 0, max: 0 })    // 1
size({ min: -5, max: 5 })   // 11

API Reference

See the full API Reference for detailed type signatures.