@ntf/math 1.4.0 → 1.4.1

package/dist/index.d.mts

@@ -1,100 +1,4 @@
-/**
- * All valid types of JavaScript you can get from `typeof`
- */
-type JavaScriptTypes = "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
-/**
- * A JavaScript function that can be typed (or not)
- */
-type JavaScriptFunction<Args extends Array<any> = Array<any>, ReturnType extends any = any> = (...args: Args) => ReturnType;
-/**
- * A mapped type for getting the type of a JavaScript value
- */
-type JavaScriptTypeMap = {
-    "string": string;
-    "number": number;
-    "bigint": bigint;
-    "boolean": boolean;
-    "symbol": symbol;
-    "undefined": undefined;
-    "object": object;
-    "function": JavaScriptFunction;
-};
-/**
- * Any kind of JavaScript number
- */
-type JavaScriptNumber = number | bigint;
-/**
- * A array that has a fixed length
- */
-type FixedArray<T, Length extends number> = Array<T> & {
-    length: Length;
-};
-/**
- * A value that might look like a hex value
- */
-type HexLike = `$${string}` | `#${string}` | `0x${string}` | string;
-/**
- * A predicate function type for verifing types
- */
-type Predicate<T> = (a: unknown) => a is T;
-/**
- * Check if `value` is a finite valid number
- * @param value A value
- */
-declare function checkNumber(value: unknown): value is number;
-/**
- * Retrieve the value of a hex string
- * @param string A string
- */
-declare function getHexValue(string: string): string;
-/**
- * Check if `value` is a hex value
- * @param value A value
- */
-declare function checkHex(value: unknown): value is HexLike;
-/**
- * Check if `value` is a string with content
- * @param value A value
- */
-declare function checkString(value: unknown): value is string;
-/**
- * Check if `value` is a array
- * @param value A value
- * @param predicate A function that checks each item
- * @param requiredLength If needed, check if it is a fixed length array
- */
-declare function checkArray<T, Length extends number>(value: unknown, predicate?: Predicate<T>, requiredLength?: number): value is FixedArray<T, Length>;
-/**
- * Check if `value` is a number array
- * @param value A value
- * @param requiredLength If needed, check if it is a fixed length array
- */
-declare function checkNumberArray<Length extends number>(value: unknown, requiredLength?: Length): value is FixedArray<number, Length>;
-/**
- * Check if `value` is a string array
- * @param value A value
- * @param requiredLength If needed, check if it is a fixed length array
- */
-declare function checkStringArray<Length extends number>(value: unknown, requiredLength?: Length): value is FixedArray<string, Length>;
-/**
- * Check if `value` has a property called `name`
- * @param value A value
- * @param propertyName The name of the property
- * @param type
- */
-declare function hasProperty<Obj extends unknown, K extends PropertyKey, T extends JavaScriptTypes>(value: Obj, propertyName: K, type: T): value is Obj & {
-    [name in K]: JavaScriptTypeMap[T];
-};
-declare const NodeJSCustomInspect: unique symbol;
-
-interface IToString {
-    /**
-     * Returns a string representation of an object.
-     */
-    toString(): string;
-    get [Symbol.toStringTag](): string;
-    [NodeJSCustomInspect](): string;
-}
+import { IToString, NodeJSCustomInspect, FixedArray } from '@ntf/types';
 
 interface IGeometryObject extends IToString {
     readonly area: number;
@@ -134,135 +38,6 @@ declare class Size implements ISize, IGeometryObject, IToVec2 {
     toVec2(): Vec2Like;
 }
 
-interface IRGB {
-    red: number;
-    green: number;
-    blue: number;
-}
-interface IToRGB {
-    toRGB(): RGBLike;
-}
-type RGBArray = [number, number, number];
-type RGBString = `rgb(${number},${number},${number})`;
-type RGBLike = IRGB | RGBArray | RGBString | IToRGB;
-type RGBArguments = [rgb: RGBLike] | RGBArray;
-interface IRBBA extends IRGB {
-    alpha: number;
-}
-interface IToRGBA {
-    toRGBA(): RGBALike;
-}
-type RGBAArray = [number, number, number, number];
-type RGBAString = `rgba(${number},${number},${number},${number})`;
-type RGBALike = IRBBA | RGBAArray | RGBAString | IToRGBA;
-type RGBAArguments = [rgba: RGBALike] | RGBAArray;
-type IAnyRGB = IRGB | IRBBA;
-type AnyRGBArray = RGBArray | RGBAArray;
-type AnyRGBString = RGBString | RGBAString;
-type IAnyToRGB = IToRGB | IToRGBA;
-type AnyRGBLike = IAnyRGB | AnyRGBArray | AnyRGBString | HexLike | number | IAnyToRGB;
-type AnyRGBArguments = RGBArguments | RGBAArguments;
-declare class RGBA implements IRBBA, IToVec2, IToVec3, IToHSL, IToHSLA, IToString {
-    private _red;
-    get red(): number;
-    set red(val: number);
-    private _green;
-    get green(): number;
-    set green(val: number);
-    private _blue;
-    get blue(): number;
-    set blue(val: number);
-    private _alpha;
-    get alpha(): number;
-    set alpha(val: number);
-    static resolve(a: unknown): RGBA;
-    static resolveArgs(args: AnyRGBArguments): RGBA;
-    static cast(a: unknown): RGBA | undefined;
-    static is(a: unknown): a is AnyRGBLike;
-    constructor(red: number, green: number, blue: number, alpha?: number);
-    toArray(withAlpha?: boolean): AnyRGBArray;
-    toJSON(withAlpha?: boolean): IAnyRGB;
-    toString(withAlpha?: boolean): AnyRGBString;
-    get [Symbol.toStringTag](): string;
-    [NodeJSCustomInspect](): string;
-    toVec2(): Vec2Like;
-    toVec3(): Vec3Like;
-    toHSL(withAlpha?: false): HSLLike;
-    toHSL(withAlpha?: true): HSLALike;
-    toHSLA(): HSLALike;
-    invert(withAlpha?: boolean): RGBA;
-}
-interface IHSL {
-    hue: number;
-    saturation: number;
-    luminace: number;
-}
-interface IToHSL {
-    toHSL(): HSLLike;
-}
-type HSLArray = [number, number, number];
-type HSLString = `hsl(${number},${number},${number})`;
-type HSLLike = IHSL | HSLArray | HSLString | IToHSL;
-type HSLArguments = HSLArray | [hsl: HSLLike];
-interface IHSLA extends IHSL {
-    alpha: number;
-}
-interface IToHSLA {
-    toHSLA(): HSLALike;
-}
-type HSLAArray = [number, number, number, number];
-type HSLAString = `hsla(${number},${number},${number},${number})`;
-type HSLALike = IHSLA | HSLAArray | HSLAString | IToHSLA;
-type HSLAArguments = HSLAArray | [hsla: HSLALike];
-type IAnyHSL = IHSL | IHSLA;
-type AnyHSLArray = HSLArray | HSLAArray;
-type AnyHSLString = HSLString | HSLAString;
-type IAnyToHSL = IToHSL | IToHSLA;
-type AnyHSLLike = IAnyHSL | AnyHSLArray | AnyHSLString | HexLike | number | IAnyToHSL;
-type AnyHSLArguments = HSLArguments | HSLAArguments;
-declare class HSLA implements IHSLA, IToRGB, IToRGBA, IToVec2, IToVec3, IToString {
-    private _hue;
-    get hue(): number;
-    set hue(val: number);
-    private _saturation;
-    get saturation(): number;
-    set saturation(val: number);
-    private _luminace;
-    get luminace(): number;
-    set luminace(val: number);
-    private _alpha;
-    get alpha(): number;
-    set alpha(val: number);
-    static resolve(a: unknown): HSLA;
-    static resolveArgs(args: AnyHSLArguments): HSLA;
-    static cast(a: unknown): HSLA | undefined;
-    static is(a: unknown): a is AnyHSLLike;
-    constructor(hue: number, saturation: number, luminace: number, alpha?: number);
-    toArray(withAlpha?: boolean): AnyHSLArray;
-    toJSON(withAlpha?: boolean): IAnyHSL;
-    toString(withAlpha?: boolean): AnyHSLString;
-    get [Symbol.toStringTag](): string;
-    [NodeJSCustomInspect](): string;
-    toRGB(withAlpha?: true): RGBALike;
-    toRGB(withAlpha?: false): RGBLike;
-    toRGBA(): RGBALike;
-    toVec2(): Vec2Like;
-    toVec3(): Vec3Like;
-    invert(withAlpha?: boolean): HSLA;
-}
-type AnyColorArray = AnyRGBArray | AnyHSLArray;
-type AnyColorString = AnyRGBString | AnyHSLString;
-type IAnyColor = IAnyRGB | IAnyHSL;
-type IAnyToColor = IAnyToRGB | IAnyToHSL;
-type AnyColorLike = AnyColorArray | AnyColorString | IAnyColor | HexLike | number;
-type AnyColorArguments = AnyColorArray | [color: AnyColorLike];
-type AnyColor = RGBA | HSLA;
-declare namespace AnyColor {
-    function cast(a: unknown, preferHSL?: boolean): AnyColor | undefined;
-    function resolve(a: unknown, preferHSL?: boolean): AnyColor;
-    function resolveArgs(args: AnyColorArguments, preferHSL?: boolean): AnyColor;
-}
-
 interface ICircle extends IVec2 {
     radius: number;
 }
@@ -634,6 +409,124 @@ declare class Quaternion implements IToVec3, IToMat3, IToMat4, IToString {
     toMat4(): Mat4Like;
 }
 
+interface IRGB {
+    red: number;
+    green: number;
+    blue: number;
+}
+interface IToRGB {
+    toRGB(): RGBLike;
+}
+type RGBArray = [number, number, number];
+type RGBString = `rgb(${number},${number},${number})`;
+type RGBLike = IRGB | RGBArray | RGBString | IToRGB;
+type RGBArguments = [rgb: RGBLike] | RGBArray;
+interface IRBBA extends IRGB {
+    alpha: number;
+}
+interface IToRGBA {
+    toRGBA(): RGBALike;
+}
+type RGBAArray = [number, number, number, number];
+type RGBAString = `rgba(${number},${number},${number},${number})`;
+type RGBALike = IRBBA | RGBAArray | RGBAString | IToRGBA;
+type RGBAArguments = [rgba: RGBALike] | RGBAArray;
+type IAnyRGB = IRGB | IRBBA;
+type AnyRGBArray = RGBArray | RGBAArray;
+type AnyRGBString = RGBString | RGBAString;
+type IAnyToRGB = IToRGB | IToRGBA;
+type AnyRGBLike = IAnyRGB | AnyRGBArray | AnyRGBString | number | IAnyToRGB;
+type AnyRGBArguments = RGBArguments | RGBAArguments;
+declare class RGBA implements IRBBA, IToVec2, IToVec3, IToHSL, IToHSLA, IToString {
+    private _red;
+    get red(): number;
+    set red(val: number);
+    private _green;
+    get green(): number;
+    set green(val: number);
+    private _blue;
+    get blue(): number;
+    set blue(val: number);
+    private _alpha;
+    get alpha(): number;
+    set alpha(val: number);
+    static resolve(a: unknown): RGBA;
+    static resolveArgs(args: AnyRGBArguments): RGBA;
+    static cast(a: unknown): RGBA | undefined;
+    static is(a: unknown): a is AnyRGBLike;
+    constructor(red: number, green: number, blue: number, alpha?: number);
+    toArray(withAlpha?: boolean): AnyRGBArray;
+    toJSON(withAlpha?: boolean): IAnyRGB;
+    toString(withAlpha?: boolean): AnyRGBString;
+    get [Symbol.toStringTag](): string;
+    [NodeJSCustomInspect](): string;
+    toVec2(): Vec2Like;
+    toVec3(): Vec3Like;
+    toHSL(withAlpha?: false): HSLLike;
+    toHSL(withAlpha?: true): HSLALike;
+    toHSLA(): HSLALike;
+    invert(withAlpha?: boolean): RGBA;
+}
+
+interface IHSL {
+    hue: number;
+    saturation: number;
+    luminace: number;
+}
+interface IToHSL {
+    toHSL(): HSLLike;
+}
+type HSLArray = [number, number, number];
+type HSLString = `hsl(${number},${number},${number})`;
+type HSLLike = IHSL | HSLArray | HSLString | IToHSL;
+type HSLArguments = HSLArray | [hsl: HSLLike];
+interface IHSLA extends IHSL {
+    alpha: number;
+}
+interface IToHSLA {
+    toHSLA(): HSLALike;
+}
+type HSLAArray = [number, number, number, number];
+type HSLAString = `hsla(${number},${number},${number},${number})`;
+type HSLALike = IHSLA | HSLAArray | HSLAString | IToHSLA;
+type HSLAArguments = HSLAArray | [hsla: HSLALike];
+type IAnyHSL = IHSL | IHSLA;
+type AnyHSLArray = HSLArray | HSLAArray;
+type AnyHSLString = HSLString | HSLAString;
+type IAnyToHSL = IToHSL | IToHSLA;
+type AnyHSLLike = IAnyHSL | AnyHSLArray | AnyHSLString | number | IAnyToHSL;
+type AnyHSLArguments = HSLArguments | HSLAArguments;
+declare class HSLA implements IHSLA, IToRGB, IToRGBA, IToVec2, IToVec3, IToString {
+    private _hue;
+    get hue(): number;
+    set hue(val: number);
+    private _saturation;
+    get saturation(): number;
+    set saturation(val: number);
+    private _luminace;
+    get luminace(): number;
+    set luminace(val: number);
+    private _alpha;
+    get alpha(): number;
+    set alpha(val: number);
+    static resolve(a: unknown): HSLA;
+    static resolveArgs(args: AnyHSLArguments): HSLA;
+    static cast(a: unknown): HSLA | undefined;
+    static is(a: unknown): a is AnyHSLLike;
+    constructor(hue: number, saturation: number, luminace: number, alpha?: number);
+    toArray(withAlpha?: boolean): AnyHSLArray;
+    toJSON(withAlpha?: boolean): IAnyHSL;
+    toString(withAlpha?: boolean): AnyHSLString;
+    get [Symbol.toStringTag](): string;
+    [NodeJSCustomInspect](): string;
+    toRGB(withAlpha?: true): RGBALike;
+    toRGB(withAlpha?: false): RGBLike;
+    toRGBA(): RGBALike;
+    toVec2(): Vec2Like;
+    toVec3(): Vec3Like;
+    invert(withAlpha?: boolean): HSLA;
+}
+
 interface IVec3 extends IVec2 {
     z: number;
 }
@@ -870,6 +763,9 @@ declare class QuadFunction extends MathFunction<[number]> {
     [NodeJSCustomInspect](): string;
 }
 
+declare function numberToRGB(number: number): FixedArray<number, 3>;
+declare function numberToRGBA(number: number): FixedArray<number, 4>;
+
 /**
  * A error when a value wasn't able to be resolved to another type
  */
@@ -958,6 +854,19 @@ declare class Triangle3D extends Triangle<Vec3> {
     get c(): number;
 }
 
+type AnyColorArray = AnyRGBArray | AnyHSLArray;
+type AnyColorString = AnyRGBString | AnyHSLString;
+type IAnyColor = IAnyRGB | IAnyHSL;
+type IAnyToColor = IAnyToRGB | IAnyToHSL;
+type AnyColorLike = AnyColorArray | AnyColorString | IAnyColor | number;
+type AnyColorArguments = AnyColorArray | [color: AnyColorLike];
+type AnyColor = RGBA | HSLA;
+declare namespace AnyColor {
+    function cast(a: unknown, preferHSL?: boolean): AnyColor | undefined;
+    function resolve(a: unknown, preferHSL?: boolean): AnyColor;
+    function resolveArgs(args: AnyColorArguments, preferHSL?: boolean): AnyColor;
+}
+
 declare class Transform2D implements IToMat3, IToString {
     parent?: Transform2D | undefined;
     origin: Vec2;
@@ -1034,4 +943,4 @@ declare function logHypot(a: number, b: number): number;
 declare const EPSILON = 1e-16;
 declare const lerp: <T extends number | bigint>(a: T, b: T, t: T) => number;
 
-export { AnyColor, type AnyColorArguments, type AnyColorArray, type AnyColorLike, type AnyColorString, type AnyHSLArguments, type AnyHSLArray, type AnyHSLLike, type AnyHSLString, type AnyRGBArguments, type AnyRGBArray, type AnyRGBLike, type AnyRGBString, BoundingBox, type BoundingBoxArgs, type BoundingBoxArray, type BoundingBoxLike, type BoundingBoxString, Circle, type CircleArguments, type CircleArray, type CircleLike, type CircleString, DJB2_OFFSET, EPSILON, FNV1_OFFSET, FNV1_PRIME, type FixedArray, HSLA, type HSLAArguments, type HSLAArray, type HSLALike, type HSLAString, type HSLArguments, type HSLArray, type HSLLike, type HSLString, type HexLike, type IAnyColor, type IAnyHSL, type IAnyRGB, type IAnyToColor, type IAnyToHSL, type IAnyToRGB, type IBoundingBox, type ICircle, type IGeometryObject, type IHSL, type IHSLA, type IHash, type IMat3, type IMat4, type IQuaternion, type IRBBA, type IRGB, type IRectangle, type ISize, type IToBoundingBox, type IToCircle, type IToHSL, type IToHSLA, type IToMat3, type IToMat4, type IToQuaternion, type IToRGB, type IToRGBA, type IToRectangle, type IToSize, type IToVec2, type IToVec3, type ITriangle, type IVec2, type IVec3, type JavaScriptFunction, type JavaScriptNumber, type JavaScriptTypeMap, type JavaScriptTypes, LinearFunction, type LinearFunctionString, MAX_ANGLE_DEGREE, MD2, Mat3, type Mat3Arguments, type Mat3Array, type Mat3Like, type Mat3NestedArray, type Mat3String, Mat4, type Mat4Arguments, type Mat4Array, type Mat4Like, type Mat4NestedArray, type Mat4String, MathFunction, NodeJSCustomInspect, type Predicate, QuadFunction, type QuadFunctionString, type QuadFunctionStrings, type QuadFunctionType, Quaternion, type QuaternionArguments, type QuaternionArray, type QuaternionLike, type QuaternionString, RGBA, type RGBAArguments, type RGBAArray, type RGBALike, type RGBAString, type RGBArguments, type RGBArray, type RGBLike, type RGBString, Rectangle, type RectangleArguments, type RectangleArray, type RectangleLike, type RectangleString, ResolveError, type SignCharacter, Size, type SizeArguments, type SizeArray, type SizeLike, type SizeString, Transform2D, Transform3D, Triangle, Triangle2D, Triangle3D, Vec2, type Vec2Arguments, type Vec2Array, type Vec2Like, type Vec2String, Vec3, type Vec3Arguments, type Vec3Array, type Vec3Like, type Vec3String, checkArray, checkHex, checkNumber, checkNumberArray, checkString, checkStringArray, clamp, clampAngleDegree, clampAngleRadian, degreeToRadian, djb2, fnv1, getHexValue, hasProperty, lerp, logHypot, radianToDegree, sdbm, signCharacter };
+export { AnyColor, type AnyColorArguments, type AnyColorArray, type AnyColorLike, type AnyColorString, type AnyHSLArguments, type AnyHSLArray, type AnyHSLLike, type AnyHSLString, type AnyRGBArguments, type AnyRGBArray, type AnyRGBLike, type AnyRGBString, BoundingBox, type BoundingBoxArgs, type BoundingBoxArray, type BoundingBoxLike, type BoundingBoxString, Circle, type CircleArguments, type CircleArray, type CircleLike, type CircleString, DJB2_OFFSET, EPSILON, FNV1_OFFSET, FNV1_PRIME, HSLA, type HSLAArguments, type HSLAArray, type HSLALike, type HSLAString, type HSLArguments, type HSLArray, type HSLLike, type HSLString, type IAnyColor, type IAnyHSL, type IAnyRGB, type IAnyToColor, type IAnyToHSL, type IAnyToRGB, type IBoundingBox, type ICircle, type IGeometryObject, type IHSL, type IHSLA, type IHash, type IMat3, type IMat4, type IQuaternion, type IRBBA, type IRGB, type IRectangle, type ISize, type IToBoundingBox, type IToCircle, type IToHSL, type IToHSLA, type IToMat3, type IToMat4, type IToQuaternion, type IToRGB, type IToRGBA, type IToRectangle, type IToSize, type IToVec2, type IToVec3, type ITriangle, type IVec2, type IVec3, LinearFunction, type LinearFunctionString, MAX_ANGLE_DEGREE, MD2, Mat3, type Mat3Arguments, type Mat3Array, type Mat3Like, type Mat3NestedArray, type Mat3String, Mat4, type Mat4Arguments, type Mat4Array, type Mat4Like, type Mat4NestedArray, type Mat4String, MathFunction, QuadFunction, type QuadFunctionString, type QuadFunctionStrings, type QuadFunctionType, Quaternion, type QuaternionArguments, type QuaternionArray, type QuaternionLike, type QuaternionString, RGBA, type RGBAArguments, type RGBAArray, type RGBALike, type RGBAString, type RGBArguments, type RGBArray, type RGBLike, type RGBString, Rectangle, type RectangleArguments, type RectangleArray, type RectangleLike, type RectangleString, ResolveError, type SignCharacter, Size, type SizeArguments, type SizeArray, type SizeLike, type SizeString, Transform2D, Transform3D, Triangle, Triangle2D, Triangle3D, Vec2, type Vec2Arguments, type Vec2Array, type Vec2Like, type Vec2String, Vec3, type Vec3Arguments, type Vec3Array, type Vec3Like, type Vec3String, clamp, clampAngleDegree, clampAngleRadian, degreeToRadian, djb2, fnv1, lerp, logHypot, numberToRGB, numberToRGBA, radianToDegree, sdbm, signCharacter };