@oliversalzburg/js-utils 0.0.18 → 0.0.19-dev.0

package/{lib/graphics → graphics}/canvas-sandbox.d.ts

@@ -26,7 +26,7 @@ export interface CanvasSandboxExpectedOptions {
 }
 /**
  * Describes an application running inside the {@linkcode CanvasSandbox}.
- * @template {CanvasSandboxExpectedOptions} TApplicationOptions The type of the options object
+ * @typeParam TApplicationOptions - The type of the options object
  * with which the application is constructed.
  * @group Graphics
  */
@@ -46,14 +46,14 @@ export interface CanvasSandboxApplication<TApplicationOptions extends CanvasSand
     paused: boolean;
     /**
      * Request the application to draw a new frame.
-     * @param delta How many milliseconds passed since the last frame draw.
-     * @param timestamp The current timestamp.
+     * @param delta - How many milliseconds passed since the last frame draw.
+     * @param timestamp - The current timestamp.
      */
     onDraw(delta: number, timestamp: number): void;
     /**
      * Reconfigure the application with the given options and restart it.
-     * @param canvas The canvas to use.
-     * @param options The new options to use.
+     * @param canvas - The canvas to use.
+     * @param options - The new options to use.
      */
     reconfigure(canvas: Canvas, options?: Partial<TApplicationOptions>): void;
     /**
@@ -68,12 +68,12 @@ export interface CanvasSandboxApplication<TApplicationOptions extends CanvasSand
 export interface CanvasSandboxOptions {
     /**
      * Should the sandbox render developer information?
-     * @default false
+     * @defaultValue false
      */
     devMode: boolean;
     /**
      * Should the sandbox default CSS be injected into the body?
-     * @default true
+     * @defaultValue true
      */
     injectDefaultCss: boolean;
 }
@@ -144,7 +144,7 @@ export interface CanvasSandboxOptions {
  *   <script src="main.ts" type="module"></script>
  * </html>
  * ```
- * @template {CanvasSandboxExpectedOptions} TApplicationOptions The type of the options
+ * @typeParam TApplicationOptions - The type of the options
  * the application in the sandbox will be constructed with.
  * @group Graphics
  */
@@ -177,11 +177,11 @@ export declare class CanvasSandbox<TApplicationOptions extends CanvasSandboxExpe
     readonly renderLoop: RenderLoop;
     /**
      * Construct a new {@linkcode CanvasSandbox}.
-     * @param window The window we're running inside.
-     * @param canvasNode The canvas node we're drawing to.
-     * @param Application The application that is going to run in the sandbox.
-     * @param options The options that the application should be constructed with.
-     * @param sandboxOptions The options for the sandbox itself.
+     * @param window - The window we're running inside.
+     * @param canvasNode - The canvas node we're drawing to.
+     * @param Application - The application that is going to run in the sandbox.
+     * @param options - The options that the application should be constructed with.
+     * @param sandboxOptions - The options for the sandbox itself.
      */
     constructor(window: Window, canvasNode: HTMLCanvasElement, Application: new (
     /**

package/{lib/graphics → graphics}/canvas-sandbox.js

@@ -7,8 +7,8 @@ import { RenderLoop } from "./render-loop.js";
  * Provides the input as-is.
  * This method exists only to make use of the `css` template string tag,
  * which allows us to use in-IDE support for CSS through the support for
- * {@link https://lit.dev/docs/components/styles/ Lit styles}.
- * @param input The CSS code.
+ * {@link https://lit.dev/docs/components/styles/ | Lit styles}.
+ * @param input - The CSS code.
  * @returns The CSS code as-is.
  */
 const css = (input) => input.join("");
@@ -116,7 +116,7 @@ export const CANVAS_SANDBOX_DEFAULT_CSS = /* PURE */ css `
  *   <script src="main.ts" type="module"></script>
  * </html>
  * ```
- * @template {CanvasSandboxExpectedOptions} TApplicationOptions The type of the options
+ * @typeParam TApplicationOptions - The type of the options
  * the application in the sandbox will be constructed with.
  * @group Graphics
  */
@@ -152,11 +152,11 @@ export class CanvasSandbox {
     #resizeDebounce = null;
     /**
      * Construct a new {@linkcode CanvasSandbox}.
-     * @param window The window we're running inside.
-     * @param canvasNode The canvas node we're drawing to.
-     * @param Application The application that is going to run in the sandbox.
-     * @param options The options that the application should be constructed with.
-     * @param sandboxOptions The options for the sandbox itself.
+     * @param window - The window we're running inside.
+     * @param canvasNode - The canvas node we're drawing to.
+     * @param Application - The application that is going to run in the sandbox.
+     * @param options - The options that the application should be constructed with.
+     * @param sandboxOptions - The options for the sandbox itself.
      */
     constructor(window, canvasNode, Application, options, sandboxOptions) {
         this.window = window;
@@ -243,7 +243,7 @@ export class CanvasSandbox {
     }
     /**
      * Reconfigures, and then restarts, the application.
-     * @param options The new options for the application.
+     * @param options - The new options for the application.
      */
     #reconfigureApplication(options = {}) {
         this.application.reconfigure(this.canvas, options);

package/{lib/graphics → graphics}/canvas.d.ts

@@ -48,8 +48,8 @@ export declare class Canvas {
     readonly options: Readonly<Partial<CanvasOptions>>;
     /**
      * Constructs a new {@linkcode Canvas}.
-     * @param canvas The canvas to wrap.
-     * @param options The configuration for this canvas.
+     * @param canvas - The canvas to wrap.
+     * @param options - The configuration for this canvas.
      */
     constructor(canvas: HTMLCanvasElement, options?: Partial<CanvasOptions>);
     /**
@@ -67,7 +67,7 @@ export declare class Canvas {
     /**
      * Draws a slightly transparent, black rectangle over the canvas,
      * and then reads the result back into the buffer.
-     * @param color The color to fade the buffer with. The alpha component of
+     * @param color - The color to fade the buffer with. The alpha component of
      * the color defines how strong the fade is. `0` is not at all, `255` makes
      * it instantly black.
      */
@@ -78,26 +78,26 @@ export declare class Canvas {
     bufferReadBack(): void;
     /**
      * Returns the color of a pixel in the back buffer.
-     * @param x The X coordinate to retrieve.
-     * @param y The X coordinate to retrieve.
+     * @param x - The X coordinate to retrieve.
+     * @param y - The X coordinate to retrieve.
      * @returns The color of the pixel at the given local.
      */
     getPixel32(x: number, y: number): number;
     /**
      * Colors a pixel in the back buffer.
-     * @param x The X coordinate to color.
-     * @param y The Y coordinate to color.
-     * @param color The color to place at the coordinate.
+     * @param x - The X coordinate to color.
+     * @param y - The Y coordinate to color.
+     * @param color - The color to place at the coordinate.
      */
     setPixel32(x: number, y: number, color: number): void;
     /**
      * Fills the entire back buffer with the given color.
-     * @param color The color to fill the back buffer with.
+     * @param color - The color to fill the back buffer with.
      */
     clearWith(color: number): void;
     /**
      * Fills the entire back buffer with the given color.
-     * @param color The color to fill the back buffer with.
+     * @param color - The color to fill the back buffer with.
      */
     blendWith(color: number): void;
 }
@@ -113,11 +113,11 @@ export declare class Canvas {
  *
  * The `alpha` value is expected to be an integer in the range from `0` to `255`.
  * `0` meaning fully transparent, `255` meaning fully opaque.
- * @param canvas The {@linkcode Canvas} to interact with.
- * @param x The X coordinate at which to place the pixel.
- * @param y The Y coordinate at which to place the pixel.
- * @param color The color of the pixel.
- * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @param canvas - The {@linkcode Canvas} to interact with.
+ * @param x - The X coordinate at which to place the pixel.
+ * @param y - The Y coordinate at which to place the pixel.
+ * @param color - The color of the pixel.
+ * @param alpha - The alpha value to use to blend the pixel with existing color at the location.
  * @group Graphics
  */
 export declare const putPixel32: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;
@@ -133,11 +133,11 @@ export declare const putPixel32: (canvas: Canvas, x: number, y: number, color: n
  *
  * The `alpha` value is expected to be an integer in the range from `0` to `255`.
  * `0` meaning fully transparent, `255` meaning fully opaque.
- * @param canvas The {@linkcode Canvas} to interact with.
- * @param x The X coordinate at which to place the pixel.
- * @param y The Y coordinate at which to place the pixel.
- * @param color The color of the pixel.
- * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @param canvas - The {@linkcode Canvas} to interact with.
+ * @param x - The X coordinate at which to place the pixel.
+ * @param y - The Y coordinate at which to place the pixel.
+ * @param color - The color of the pixel.
+ * @param alpha - The alpha value to use to blend the pixel with existing color at the location.
  * @group Graphics
  */
 export declare const putPixel32Add: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;
@@ -153,22 +153,22 @@ export declare const putPixel32Add: (canvas: Canvas, x: number, y: number, color
  *
  * The `alpha` value is expected to be an integer in the range from `0` to `255`.
  * `0` meaning fully transparent, `255` meaning fully opaque.
- * @param canvas The {@linkcode Canvas} to interact with.
- * @param x The X coordinate at which to place the pixel.
- * @param y The Y coordinate at which to place the pixel.
- * @param color The color of the pixel.
- * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @param canvas - The {@linkcode Canvas} to interact with.
+ * @param x - The X coordinate at which to place the pixel.
+ * @param y - The Y coordinate at which to place the pixel.
+ * @param color - The color of the pixel.
+ * @param alpha - The alpha value to use to blend the pixel with existing color at the location.
  * @group Graphics
  */
 export declare const putPixel32Sub: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;
 /**
  * Linearly blends a new pixel with an existing color value in a {@linkcode Canvas}.
  * Compared to {@linkcode putPixel32}, this function supports sub-pixel placement, but is dramatically slower.
- * @param canvas The {@linkcode Canvas} to interact with.
- * @param x The X coordinate at which to place the pixel.
- * @param y The Y coordinate at which to place the pixel.
- * @param color The color of the pixel.
- * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @param canvas - The {@linkcode Canvas} to interact with.
+ * @param x - The X coordinate at which to place the pixel.
+ * @param y - The Y coordinate at which to place the pixel.
+ * @param color - The color of the pixel.
+ * @param alpha - The alpha value to use to blend the pixel with existing color at the location.
  * @group Graphics
  */
 export declare const putSubPixel32: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;

package/{lib/graphics → graphics}/canvas.js

@@ -69,8 +69,8 @@ export class Canvas {
     options;
     /**
      * Constructs a new {@linkcode Canvas}.
-     * @param canvas The canvas to wrap.
-     * @param options The configuration for this canvas.
+     * @param canvas - The canvas to wrap.
+     * @param options - The configuration for this canvas.
      */
     constructor(canvas, options = {}) {
         this.#width = canvas.width;
@@ -120,7 +120,7 @@ export class Canvas {
     /**
      * Draws a slightly transparent, black rectangle over the canvas,
      * and then reads the result back into the buffer.
-     * @param color The color to fade the buffer with. The alpha component of
+     * @param color - The color to fade the buffer with. The alpha component of
      * the color defines how strong the fade is. `0` is not at all, `255` makes
      * it instantly black.
      */
@@ -139,8 +139,8 @@ export class Canvas {
     }
     /**
      * Returns the color of a pixel in the back buffer.
-     * @param x The X coordinate to retrieve.
-     * @param y The X coordinate to retrieve.
+     * @param x - The X coordinate to retrieve.
+     * @param y - The X coordinate to retrieve.
      * @returns The color of the pixel at the given local.
      */
     getPixel32(x, y) {
@@ -149,9 +149,9 @@ export class Canvas {
     }
     /**
      * Colors a pixel in the back buffer.
-     * @param x The X coordinate to color.
-     * @param y The Y coordinate to color.
-     * @param color The color to place at the coordinate.
+     * @param x - The X coordinate to color.
+     * @param y - The Y coordinate to color.
+     * @param color - The color to place at the coordinate.
      */
     setPixel32(x, y, color) {
         const bufferOffset = (x + y * this.#width) * 4;
@@ -162,7 +162,7 @@ export class Canvas {
     }
     /**
      * Fills the entire back buffer with the given color.
-     * @param color The color to fill the back buffer with.
+     * @param color - The color to fill the back buffer with.
      */
     clearWith(color) {
         const r = getR(color);
@@ -178,7 +178,7 @@ export class Canvas {
     }
     /**
      * Fills the entire back buffer with the given color.
-     * @param color The color to fill the back buffer with.
+     * @param color - The color to fill the back buffer with.
      */
     blendWith(color) {
         const r = getR(color);
@@ -204,11 +204,11 @@ export class Canvas {
  *
  * The `alpha` value is expected to be an integer in the range from `0` to `255`.
  * `0` meaning fully transparent, `255` meaning fully opaque.
- * @param canvas The {@linkcode Canvas} to interact with.
- * @param x The X coordinate at which to place the pixel.
- * @param y The Y coordinate at which to place the pixel.
- * @param color The color of the pixel.
- * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @param canvas - The {@linkcode Canvas} to interact with.
+ * @param x - The X coordinate at which to place the pixel.
+ * @param y - The Y coordinate at which to place the pixel.
+ * @param color - The color of the pixel.
+ * @param alpha - The alpha value to use to blend the pixel with existing color at the location.
  * @group Graphics
  */
 export const putPixel32 = (canvas, x, y, color, alpha) => {
@@ -231,11 +231,11 @@ export const putPixel32 = (canvas, x, y, color, alpha) => {
  *
  * The `alpha` value is expected to be an integer in the range from `0` to `255`.
  * `0` meaning fully transparent, `255` meaning fully opaque.
- * @param canvas The {@linkcode Canvas} to interact with.
- * @param x The X coordinate at which to place the pixel.
- * @param y The Y coordinate at which to place the pixel.
- * @param color The color of the pixel.
- * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @param canvas - The {@linkcode Canvas} to interact with.
+ * @param x - The X coordinate at which to place the pixel.
+ * @param y - The Y coordinate at which to place the pixel.
+ * @param color - The color of the pixel.
+ * @param alpha - The alpha value to use to blend the pixel with existing color at the location.
  * @group Graphics
  */
 export const putPixel32Add = (canvas, x, y, color, alpha) => {
@@ -258,11 +258,11 @@ export const putPixel32Add = (canvas, x, y, color, alpha) => {
  *
  * The `alpha` value is expected to be an integer in the range from `0` to `255`.
  * `0` meaning fully transparent, `255` meaning fully opaque.
- * @param canvas The {@linkcode Canvas} to interact with.
- * @param x The X coordinate at which to place the pixel.
- * @param y The Y coordinate at which to place the pixel.
- * @param color The color of the pixel.
- * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @param canvas - The {@linkcode Canvas} to interact with.
+ * @param x - The X coordinate at which to place the pixel.
+ * @param y - The Y coordinate at which to place the pixel.
+ * @param color - The color of the pixel.
+ * @param alpha - The alpha value to use to blend the pixel with existing color at the location.
  * @group Graphics
  */
 export const putPixel32Sub = (canvas, x, y, color, alpha) => {
@@ -276,11 +276,11 @@ export const putPixel32Sub = (canvas, x, y, color, alpha) => {
 /**
  * Linearly blends a new pixel with an existing color value in a {@linkcode Canvas}.
  * Compared to {@linkcode putPixel32}, this function supports sub-pixel placement, but is dramatically slower.
- * @param canvas The {@linkcode Canvas} to interact with.
- * @param x The X coordinate at which to place the pixel.
- * @param y The Y coordinate at which to place the pixel.
- * @param color The color of the pixel.
- * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @param canvas - The {@linkcode Canvas} to interact with.
+ * @param x - The X coordinate at which to place the pixel.
+ * @param y - The Y coordinate at which to place the pixel.
+ * @param color - The color of the pixel.
+ * @param alpha - The alpha value to use to blend the pixel with existing color at the location.
  * @group Graphics
  */
 export const putSubPixel32 = (canvas, x, y, color, alpha) => {

package/{lib/graphics → graphics}/core.d.ts

@@ -11,17 +11,17 @@ export declare const GOLDEN_RATIO = 1.618033988749;
 export declare const PALETTES: number[][];
 /**
  * Constrains a color component value to single-byte range (`0`-`255`).
- * @param c A color component value.
+ * @param c - A color component value.
  * @returns The input value constrained into single-byte range.
  * @group Graphics
  */
 export declare const safeRGBComponent: (c: number) => number;
 /**
  * Constructs a 32bit integer value that represents an RGBA color value.
- * @param r The R component.
- * @param g The G component.
- * @param b The B component.
- * @param a The A component.
+ * @param r - The R component.
+ * @param g - The G component.
+ * @param b - The B component.
+ * @param a - The A component.
  * @returns The constructed color value.
  * @group Graphics
  */
@@ -29,37 +29,37 @@ export declare const fromRGBA: (r: number, g: number, b: number, a: number) => n
 /**
  * Constructs a 32bit integer value that represents an RGBA color value.
  * The A component is fixed to `255`
- * @param r The R component.
- * @param g The G component.
- * @param b The B component.
+ * @param r - The R component.
+ * @param g - The G component.
+ * @param b - The B component.
  * @returns The constructed color value.
  * @group Graphics
  */
 export declare const fromRGB: (r: number, g: number, b: number) => number;
 /**
  * Extracts the R component from a color value.
- * @param color The color value.
+ * @param color - The color value.
  * @returns The R component of the color value.
  * @group Graphics
  */
 export declare const getR: (color: number) => number;
 /**
  * Extracts the G component from a color value.
- * @param color The color value.
+ * @param color - The color value.
  * @returns The G component of the color value.
  * @group Graphics
  */
 export declare const getG: (color: number) => number;
 /**
  * Extracts the B component from a color value.
- * @param color The color value.
+ * @param color - The color value.
  * @returns The B component of the color value.
  * @group Graphics
  */
 export declare const getB: (color: number) => number;
 /**
  * Extracts the A component from a color value.
- * @param color The color value.
+ * @param color - The color value.
  * @returns The A component of the color value.
  * @group Graphics
  */
@@ -68,9 +68,9 @@ export declare const getA: (color: number) => number;
  * Returns a new color that is a blend between a source and a destination
  * color linerally. The alpha component in these colors is ignored. Instead, the provided
  * `alpha` value is used to blend between the two colors.
- * @param src The source color.
- * @param dst The destination color.
- * @param alpha The alpha value to use for blending.
+ * @param src - The source color.
+ * @param dst - The destination color.
+ * @param alpha - The alpha value to use for blending.
  * @returns The blended color.
  * @group Graphics
  */
@@ -79,9 +79,9 @@ export declare const blend: (src: number, dst: number, alpha: number) => number;
  * Returns a new color that is a blend between a source and a destination
  * color additively. The alpha component in these colors is ignored. Instead, the provided
  * `alpha` value is used to blend between the two colors.
- * @param src The source color.
- * @param dst The destination color.
- * @param alpha The alpha value to use for blending.
+ * @param src - The source color.
+ * @param dst - The destination color.
+ * @param alpha - The alpha value to use for blending.
  * @returns The blended color.
  * @group Graphics
  */
@@ -90,9 +90,9 @@ export declare const blendAdditive: (src: number, dst: number, alpha: number) =>
  * Returns a new color that is a blend between a source and a destination
  * color subtractively. The alpha component in these colors is ignored. Instead, the provided
  * `alpha` value is used to blend between the two colors.
- * @param src The source color.
- * @param dst The destination color.
- * @param alpha The alpha value to use for blending.
+ * @param src - The source color.
+ * @param dst - The destination color.
+ * @param alpha - The alpha value to use for blending.
  * @returns The blended color.
  * @group Graphics
  */
@@ -103,7 +103,7 @@ export declare const blendSubtractive: (src: number, dst: number, alpha: number)
  * @returns A random color.
  * @group Graphics
  */
-export declare const somecolor: () => number;
+export declare const someColor: () => number;
 /**
  * Switches the global palette to the next available preset.
  * @returns The new new global palette.
@@ -112,7 +112,7 @@ export declare const somecolor: () => number;
 export declare const nextPalette: () => number[];
 /**
  * Converts a color value to grayscale.
- * @param color The color to convert.
+ * @param color - The color to convert.
  * @returns The grayscale value appropriate for the color.
  * @group Graphics
  */

package/{lib/graphics → graphics}/core.js

@@ -330,7 +330,7 @@ export const PALETTES = [
 ];
 /**
  * Constrains a color component value to single-byte range (`0`-`255`).
- * @param c A color component value.
+ * @param c - A color component value.
  * @returns The input value constrained into single-byte range.
  * @group Graphics
  */
@@ -345,10 +345,10 @@ export const safeRGBComponent = (c) => {
 };
 /**
  * Constructs a 32bit integer value that represents an RGBA color value.
- * @param r The R component.
- * @param g The G component.
- * @param b The B component.
- * @param a The A component.
+ * @param r - The R component.
+ * @param g - The G component.
+ * @param b - The B component.
+ * @param a - The A component.
  * @returns The constructed color value.
  * @group Graphics
  */
@@ -362,9 +362,9 @@ export const fromRGBA = (r, g, b, a) => {
 /**
  * Constructs a 32bit integer value that represents an RGBA color value.
  * The A component is fixed to `255`
- * @param r The R component.
- * @param g The G component.
- * @param b The B component.
+ * @param r - The R component.
+ * @param g - The G component.
+ * @param b - The B component.
  * @returns The constructed color value.
  * @group Graphics
  */
@@ -373,7 +373,7 @@ export const fromRGB = (r, g, b) => {
 };
 /**
  * Extracts the R component from a color value.
- * @param color The color value.
+ * @param color - The color value.
  * @returns The R component of the color value.
  * @group Graphics
  */
@@ -382,7 +382,7 @@ export const getR = (color) => {
 };
 /**
  * Extracts the G component from a color value.
- * @param color The color value.
+ * @param color - The color value.
  * @returns The G component of the color value.
  * @group Graphics
  */
@@ -391,7 +391,7 @@ export const getG = (color) => {
 };
 /**
  * Extracts the B component from a color value.
- * @param color The color value.
+ * @param color - The color value.
  * @returns The B component of the color value.
  * @group Graphics
  */
@@ -400,7 +400,7 @@ export const getB = (color) => {
 };
 /**
  * Extracts the A component from a color value.
- * @param color The color value.
+ * @param color - The color value.
  * @returns The A component of the color value.
  * @group Graphics
  */
@@ -411,9 +411,9 @@ export const getA = (color) => {
  * Returns a new color that is a blend between a source and a destination
  * color linerally. The alpha component in these colors is ignored. Instead, the provided
  * `alpha` value is used to blend between the two colors.
- * @param src The source color.
- * @param dst The destination color.
- * @param alpha The alpha value to use for blending.
+ * @param src - The source color.
+ * @param dst - The destination color.
+ * @param alpha - The alpha value to use for blending.
  * @returns The blended color.
  * @group Graphics
  */
@@ -432,9 +432,9 @@ export const blend = (src, dst, alpha) => {
  * Returns a new color that is a blend between a source and a destination
  * color additively. The alpha component in these colors is ignored. Instead, the provided
  * `alpha` value is used to blend between the two colors.
- * @param src The source color.
- * @param dst The destination color.
- * @param alpha The alpha value to use for blending.
+ * @param src - The source color.
+ * @param dst - The destination color.
+ * @param alpha - The alpha value to use for blending.
  * @returns The blended color.
  * @group Graphics
  */
@@ -451,9 +451,9 @@ export const blendAdditive = (src, dst, alpha) => {
  * Returns a new color that is a blend between a source and a destination
  * color subtractively. The alpha component in these colors is ignored. Instead, the provided
  * `alpha` value is used to blend between the two colors.
- * @param src The source color.
- * @param dst The destination color.
- * @param alpha The alpha value to use for blending.
+ * @param src - The source color.
+ * @param dst - The destination color.
+ * @param alpha - The alpha value to use for blending.
  * @returns The blended color.
  * @group Graphics
  */
@@ -475,8 +475,7 @@ export const blendSubtractive = (src, dst, alpha) => {
  * @returns A random color.
  * @group Graphics
  */
-export const somecolor = () => {
-    // pick some random good color
+export const someColor = () => {
     const color = PALETTES[PALETTE_INDEX][Math.trunc(random.nextFloat() * PALETTES[PALETTE_INDEX].length)];
     return (color << 8) | 0xff;
 };
@@ -494,7 +493,7 @@ export const nextPalette = () => {
 };
 /**
  * Converts a color value to grayscale.
- * @param color The color to convert.
+ * @param color - The color to convert.
  * @returns The grayscale value appropriate for the color.
  * @group Graphics
  */