@trakit/objects 0.0.1 → 0.0.6

package/_publish/objects/API/Conversion.d.ts

@@ -0,0 +1,255 @@
+/**
+ * A generic converter from one {@link UserMeasurementPreference} to another.
+ * Does not convert from one size to another in the same {@link UserMeasurementPreference}.
+ * Units must be given in equivalent sizes ie: gallons to litres, kilometers to miles.
+ * @param number
+ * @param fromUnit
+ * @param toUnit
+ */
+export declare function CONVERT_FROM_TO(number: number, fromUnit: string, toUnit: string): number;
+/**
+ * Value in square meters converted to square feet.
+ * @param area
+ */
+export declare function CONVERT_SQM_TO_SQFT(area: number): number;
+/**
+ * Value in square meters converted to square yards.
+ * @param area
+ */
+export declare function CONVERT_SQM_TO_YARDS(area: number): number;
+/**
+ * Value in square kilometres converted to square miles.
+ * @param area
+ */
+export declare function CONVERT_SQKM_TO_SQMI(area: number): number;
+/**
+ * Value in hectares converted to acres.
+ * @param area
+ */
+export declare function CONVERT_HECTARE_TO_ACRE(area: number): number;
+/**
+ * Value in square feet converted to square meters.
+ * @param area
+ */
+export declare function CONVERT_SQFT_TO_SQM(area: number): number;
+/**
+ * Value in square feet converted to square yards.
+ * @param area
+ */
+export declare function CONVERT_YARDS_TO_SQM(area: number): number;
+/**
+ * Value in square miles converted to square kilometres.
+ * @param area
+ */
+export declare function CONVERT_SQMI_TO_SQKM(area: number): number;
+/**
+ * Value in acres converted to hectares.
+ * @param area
+ */
+export declare function CONVERT_ACRE_TO_HECTARE(area: number): number;
+/**
+ * Value in kilometres converted to miles.
+ * @param distance
+ */
+export declare function CONVERT_KILOMETRES_TO_MILES(distance: number): number;
+/**
+ * Value in metres converted to yards.
+ * @param distance
+ */
+export declare function CONVERT_METRES_TO_YARDS(distance: number): number;
+/**
+ * Value in metres converted to feet.
+ * @param distance
+ */
+export declare function CONVERT_METRES_TO_FEET(distance: number): number;
+/**
+ * Value in centimetres converted to inches.
+ * @param distance
+ */
+export declare function CONVERT_CENTIMETRES_TO_INCHES(distance: number): number;
+/**
+ * Value in miles converted to kilometres.
+ * @param distance
+ */
+export declare function CONVERT_MILES_TO_KILOMETRES(distance: number): number;
+/**
+ * Value in yards converted to metres.
+ * @param distance
+ */
+export declare function CONVERT_YARDS_TO_METRES(distance: number): number;
+/**
+ * Value in feet converted to metres.
+ * @param distance
+ */
+export declare function CONVERT_FEET_TO_METRES(distance: number): number;
+/**
+ * Value in inches converted to centimetres.
+ * @param distance
+ */
+export declare function CONVERT_INCHES_TO_CENTIMETRES(distance: number): number;
+/**
+ * Value in kilo-pascals converted to pounds per square inch.
+ * @param pressure
+ */
+export declare function CONVERT_KPA_TO_PSI(pressure: number): number;
+/**
+ * Value in pounds per square inch converted to kilo-pascals.
+ * @param pressure
+ */
+export declare function CONVERT_PSI_TO_KPA(pressure: number): number;
+/**
+ * Value in Celsius converted to Fahrenheit.
+ * @param temperature
+ */
+export declare function CONVERT_CELCIUS_TO_FAHRENHEIT(temperature: number): number;
+/**
+ * Value in Fahrenheit converted to Celsius.
+ * @param temperature
+ */
+export declare function CONVERT_FAHRENHEIT_TO_CELCIUS(temperature: number): number;
+/**
+ * Value in litres converted to US standard gallons.
+ * @param volume
+ */
+export declare function CONVERT_LITRES_TO_GALLONS_US(volume: number): number;
+/**
+ * Value in litres converted to British gallons.
+ * @param volume
+ */
+export declare function CONVERT_LITRES_TO_GALLONS_UK(volume: number): number;
+/**
+ * Value in millilitres converted to US standard fluid ounces.
+ * @param volume
+ */
+export declare function CONVERT_MILLILITRES_TO_OUNCES_US(volume: number): number;
+/**
+ * Value in millilitres converted to British fluid ounces.
+ * @param volume
+ */
+export declare function CONVERT_MILLILITRES_TO_OUNCES_UK(volume: number): number;
+/**
+ * Value in US standard gallons converted to litres.
+ * @param volume
+ */
+export declare function CONVERT_GALLONS_US_TO_LITRES(volume: number): number;
+/**
+ * Value in British gallons converted to litres.
+ * @param volume
+ */
+export declare function CONVERT_GALLONS_UK_TO_LITRES(volume: number): number;
+/**
+ * Value in US standard fluid ounces converted to millilitres.
+ * @param volume
+ */
+export declare function CONVERT_OUNCES_US_TO_MILLILITRES(volume: number): number;
+/**
+ * Value in British fluid ounces converted to millilitres.
+ * @param volume
+ */
+export declare function CONVERT_OUNCES_UK_TO_MILLILITRES(volume: number): number;
+/**
+ * Value in kilograms converted to pounds.
+ * @param weight
+ */
+export declare function CONVERT_KG_TO_LBS(weight: number): number;
+/**
+ * Value in grams converted to ounces.
+ * @param weight
+ */
+export declare function CONVERT_GRAM_TO_OZ(weight: number): number;
+/**
+ * Value in metric tonnes converted to US (short) tons.
+ * @param weight
+ */
+export declare function CONVERT_TONNE_TO_TON_US(weight: number): number;
+/**
+ * Value in metric tonnes converted to British (long) tons.
+ * @param weight
+ */
+export declare function CONVERT_TONNE_TO_TON_UK(weight: number): number;
+/**
+ * Value in pounds converted to kilograms.
+ * @param weight
+ */
+export declare function CONVERT_LBS_TO_KG(weight: number): number;
+/**
+ * Value in ounces converted to grams.
+ * @param weight
+ */
+export declare function CONVERT_OZ_TO_GRAM(weight: number): number;
+/**
+ * Value in US (short) tons converted to metric tonnes.
+ * @param weight
+ */
+export declare function CONVERT_TON_US_TO_TONNE(weight: number): number;
+/**
+ * Value in British (long) tons converted to metric tonnes.
+ * @param weight
+ */
+export declare function CONVERT_TON_UK_TO_TONNE(weight: number): number;
+/**
+ * Returns the corollary of either miles per US standard gallon or litres per 100 kilometres.
+ * @param fuelEconomy
+ */
+export declare function CONVERT_BETWEEN_MPGUS_AND_L100KM(fuelEconomy: number): number;
+/**
+ * Returns the corollary of either miles per British gallon or litres per 100 kilometres.
+ * @param fuelEconomy
+ */
+export declare function CONVERT_BETWEEN_MPGUK_AND_L100KM(fuelEconomy: number): number;
+/**
+ * Returns the corollary of either miles per kilowatt hour or kilowatt hour per 100 kilometres.
+ * @param electricEconomy
+ */
+export declare function CONVERT_BETWEEN_MPKWH_AND_KWH100KM(electricEconomy: number): number;
+export declare const CONVERT: {
+    fromTo: typeof CONVERT_FROM_TO;
+    sqmToSqft: typeof CONVERT_SQM_TO_SQFT;
+    sqftToSqm: typeof CONVERT_SQFT_TO_SQM;
+    sqmToSqy: typeof CONVERT_SQM_TO_YARDS;
+    yftToSqm: typeof CONVERT_YARDS_TO_SQM;
+    sqkmToSqmi: typeof CONVERT_SQKM_TO_SQMI;
+    sqmiToSqkm: typeof CONVERT_SQMI_TO_SQKM;
+    haToAc: typeof CONVERT_HECTARE_TO_ACRE;
+    acToHa: typeof CONVERT_ACRE_TO_HECTARE;
+    kmToMi: typeof CONVERT_KILOMETRES_TO_MILES;
+    miToKm: typeof CONVERT_MILES_TO_KILOMETRES;
+    mToYd: typeof CONVERT_METRES_TO_YARDS;
+    ydToM: typeof CONVERT_YARDS_TO_METRES;
+    mToFt: typeof CONVERT_METRES_TO_FEET;
+    ftToM: typeof CONVERT_FEET_TO_METRES;
+    cmToIn: typeof CONVERT_CENTIMETRES_TO_INCHES;
+    inToCm: typeof CONVERT_INCHES_TO_CENTIMETRES;
+    mpgToL100km: typeof CONVERT_BETWEEN_MPGUS_AND_L100KM;
+    mpgUKToL100km: typeof CONVERT_BETWEEN_MPGUK_AND_L100KM;
+    mpkwhToKwh100kim: typeof CONVERT_BETWEEN_MPKWH_AND_KWH100KM;
+    l100kmToMpg: typeof CONVERT_BETWEEN_MPGUS_AND_L100KM;
+    l100kmToMpgUK: typeof CONVERT_BETWEEN_MPGUK_AND_L100KM;
+    kwh100kimToMpkwh: typeof CONVERT_BETWEEN_MPKWH_AND_KWH100KM;
+    kpaToPsi: typeof CONVERT_KPA_TO_PSI;
+    psiToKpa: typeof CONVERT_PSI_TO_KPA;
+    kphToMph: typeof CONVERT_KILOMETRES_TO_MILES;
+    mphToKph: typeof CONVERT_MILES_TO_KILOMETRES;
+    mpsToFtps: typeof CONVERT_METRES_TO_FEET;
+    ftpsToMps: typeof CONVERT_FEET_TO_METRES;
+    cmpsToInps: typeof CONVERT_CENTIMETRES_TO_INCHES;
+    inpsToCmps: typeof CONVERT_INCHES_TO_CENTIMETRES;
+    cToF: typeof CONVERT_CELCIUS_TO_FAHRENHEIT;
+    fToC: typeof CONVERT_FAHRENHEIT_TO_CELCIUS;
+    lToGal: typeof CONVERT_LITRES_TO_GALLONS_US;
+    lToGalUK: typeof CONVERT_LITRES_TO_GALLONS_UK;
+    galToL: typeof CONVERT_GALLONS_US_TO_LITRES;
+    galUKToL: typeof CONVERT_GALLONS_UK_TO_LITRES;
+    mlToFloz: typeof CONVERT_MILLILITRES_TO_OUNCES_US;
+    mlToFlozUK: typeof CONVERT_MILLILITRES_TO_OUNCES_UK;
+    flozToMl: typeof CONVERT_OUNCES_US_TO_MILLILITRES;
+    flozUKToMl: typeof CONVERT_OUNCES_UK_TO_MILLILITRES;
+    kgToLbs: typeof CONVERT_KG_TO_LBS;
+    lbsToKg: typeof CONVERT_LBS_TO_KG;
+    gToOz: typeof CONVERT_GRAM_TO_OZ;
+    ozToG: typeof CONVERT_OZ_TO_GRAM;
+    tToTon: typeof CONVERT_TONNE_TO_TON_US;
+    tonToT: typeof CONVERT_TON_US_TO_TONNE;
+    tToTonUK: typeof CONVERT_TONNE_TO_TON_UK;
+    tonUKToT: typeof CONVERT_TON_UK_TO_TONNE;
+};

package/_publish/objects/API/Encoding.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Encodes the given string as a {@link Provider#password}.
+ */
+export declare function PASSWORD_ENCODE(value: string): string;
+/**
+ * Decodes the given {@link Provider#password} as a human readable value.
+ * @param value
+ * */
+export declare function PASSWORD_DECODE(value: string): string;

package/_publish/objects/API/Files.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Groups digits of a number together to make a more human readable version.
+ * @param number The number to be prettified
+ * @param size				Quantity of digits per number group.  The default is 3.
+ * @param delimiter			Character(s) to use to divide the integer groups.  The detauls is ",".
+ * @param decimalDelimiter	Character(s) to use to divide the decimal groups.  The detauls is same as delimiter.
+ * @param point			Character(s) to use to divide the integer groups from the decimal groups. The detauls is ".".
+ * @throws {TypeError}				size must be greater than zero
+ */
+export declare function NUMBER_GROUPS(number: number, size?: number, delimiter?: string, decimalDelimiter?: string, point?: string): string;
+/**
+ * Creates a more human readable string representation of the filesize.
+ * @param bytes
+ * @param places			The number of decimal places.  Default is 0.
+ * @param maxScale			Largest size-scale to use for representing the file-size.  Default is "MB" (Megabyte), can be a value between 0 (Byte) and 6 (Exabyte).
+ * @param groupSize			Quantity of digits per number group.  The default is 3.
+ * @param groupDelimiter	Character(s) to use to divide the integer groups.  The detauls is ",".
+ * @param decimalDelimiter	Character(s) to use to divide the decimal groups.  The detauls is same as delimiter.
+ * @param point				Character(s) to use to divide the integer groups from the decimal groups. The detauls is ".".
+ * */
+export declare function FILESIZE_HELPER(bytes: number, places?: number, maxScale?: string, groupSize?: number, groupDelimiter?: string, decimalDelimiter?: string, point?: string): string;

package/_publish/objects/API/Functions.d.ts

@@ -0,0 +1,196 @@
+import { datetime, JsonObject, nothing } from "./Types";
+/**
+ * Checks for both null and undefined
+ * @param value The variable to check
+ */
+export declare function IS_NOTHING(value: any): value is nothing;
+/**
+ * Checks to see if the given parameter is a number object or number literal.
+ * @param value The variable to check
+ */
+export declare function IS_BOOLEAN(value: any): value is boolean;
+/**
+ * Checks to see if the given parameter is a number object or number literal.
+ * @param value The variable to check
+ */
+export declare function IS_NUMBER(value: any): value is number;
+/**
+ * Checks to see if the given parameter is a number object or number literal.
+ * @param value The variable to check
+ */
+export declare function IS_STRING(value: any): value is string;
+/**
+ * Checks to see if the given parameter is a function from this window or another.
+ * @param value The variable to check
+ */
+export declare function IS_FUNCTION(value: any): value is Function;
+/**
+ * Returns the name of the given value's type.
+ * @param value The variable to check
+ */
+export declare function OBJECT_TYPE(value: any): string;
+/**
+ * Almost the opposite of {@link isNaN}.
+ * Checks to see if the given parameter is a number object, or number literal, and that it is not {@code value|NaN|Infinity}.
+ * This method will return  {@code value|false} for values: {@code value|""}, {@code value|"1234"}, {@code value|null}, {@code value|undefined}, {@code value|true}, and {@code value|false}.
+ * @param value The variable to check
+ */
+export declare function IS_AN(value: any): value is number;
+/**
+ * Rounds a number to the desired number of decimal places. Using a negative places value will round to the nearest ten.
+ * @param number The number to be rounded
+ * @param places The number of decimal places.  Default is 0.
+ */
+export declare function ROUND_TO(number: number, places?: number): number;
+/**
+ * Clips a number to the specified minimum and maximum values.
+ * @param n	The number to clip
+ * @param min	Minimum allowable value
+ * @param max	Maximum allowable value
+ */
+export declare function CLIP(n: number, min: number, max: number): number;
+/**
+ * Calculates the Pythagorean length of a triangle given the length of the other two sides.
+ * @param width
+ * @param height
+ */
+export declare function PYTHAGORA(width: number, height: number): number;
+/**
+ * Parses a base-10 integer number from the given value.
+ * @param value
+ */
+export declare function ID(value: any): number;
+/**
+ * Creates a Date object out of the given value.
+ * @param value
+ */
+export declare function DATE(value?: Date | number | datetime | nothing): Date;
+/**
+ * An implementation of the Douglas-Peucker path reduction algorithm.
+ * @template TCoord			A type of coordinate like a pixel or lat/lng.
+ * @param source			Array of coordinates.
+ * @param triangleHeight	Callback which performs a triangle height calculation between first point, middle point, and last point.
+ * @param tolerance			The "kink" threshold.
+ * @returns					Elements in the array are true if they should be kept.
+ */
+export declare function DOUGLASPEUCKER_INTERNAL<TCoord>(source: TCoord[], triangleHeight: (first: TCoord, middle: TCoord, last: TCoord) => number, tolerance: number): boolean[];
+/**
+ * An implementation of the {@link https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm|Ramer-Douglas-Peucker} path reduction algorithm.
+ * The source array should be more than two items in length, otherwise reduction is pointless.
+ * The callback function returns a number (greater than zero) as the triangle height as defiend by three points; first point, middle point, and last point.
+ * The "kink" threshold is set using the tolerance argument which must be a number greater than or equal to zero.
+ * @template TCoord
+ * @param source						Array of coordinates of type "T".
+ * @param triangleHeight	Callback which performs a triangle height calculation between first point, middle point, and last point.
+ * @param tolerance						The "kink" threshold
+ */
+export declare function DOUGLASPEUCKER<TCoord>(source: TCoord[], triangleHeight: (first: TCoord, middle: TCoord, last: TCoord) => number, tolerance: number): TCoord[];
+/**
+ * Returns a plural version of the given word.
+ * This obviously doesn't work for every word imaginable, but covers the standard object names in the Trak-iT APIs.
+ * @param word
+ * @returns
+ */
+export declare function PLURALIZE(word: string): string;
+/**
+ * Returns a singular version of the given word.
+ * This obviously doesn't work for every word imaginable, but covers the standard object names in the Trak-iT APIs.
+ * @param word
+ * @returns
+ */
+export declare function SINGULARIZE(word: string): string;
+/**
+ * Returns the given word with the first letter capitalized (or lower-cased).
+ * @param word
+ * @param upper
+ * @returns
+ */
+export declare function CAPITALIZE(word: string, upper?: boolean): string;
+/**
+ * Parses the input and returns a valid phone number prefixed by 1, or NaN if invalid.
+ * @param phone
+ * */
+export declare function PHONE_PARSE(phone: string | number | undefined): number;
+/**
+ * Internal method for returning a string representation of the given number, padded with zeros.
+ * @param num
+ * @param length
+ * @param decimals
+ * @param radix
+ */
+export declare function ZERO_PADDED(num: number, length: number, decimals?: number, radix?: number): string;
+/**
+ *
+ * @param source
+ * @param deep
+ * @returns
+ */
+export declare function MAP_TO_JSON(source: Map<any, any>, deep?: boolean): JsonObject;
+/**
+ *
+ * @param source
+ * @param deep
+ * @returns
+ */
+export declare function MAP_TO_JSON_PREDICATE<K, V>(source: Map<K, V>, predicate: (key: K, value: V) => [string, any]): JsonObject;
+/**
+ *
+ * @param map
+ * @param deep
+ * @returns
+ */
+export declare function JSON_TO_MAP_PREDICATE<K, V>(source: object, predicate: (key: string, value: any) => [K, V]): Map<K, V>;
+/**
+ *
+ * @param map
+ * @param deep
+ * @returns
+ */
+export declare function JSON_TO_MAP(source: object, deep?: boolean): Map<string, any>;
+/**
+ *
+ * @param map
+ * @param deep
+ * @returns
+ */
+export declare function JSON_TO_MAP_KEY_CODIFIED(source: object, deep?: boolean): Map<string, any>;
+/**
+ *
+ * @param map
+ * @param deep
+ * @returns
+ */
+export declare function JSON_TO_MAP_KEY_ULONG(source: object, deep?: boolean): Map<number, any>;
+/**
+ *
+ * @param this
+ * @param value
+ * @returns
+ */
+export declare function STRING_TO_ENUM<T extends {
+    [key: string]: T;
+}>(this: T, value: string): T;
+/**
+ * Serializes a {@link Date} to an ISO string, or null (for use in {@link ISerializable.toJSON}).
+ * @param date
+ */
+export declare function JSON_DATE(date: Date): string | null;
+/**
+ * Serializes a {@link Number} as itself, or null instead of {@link NaN} (for use in {@link ISerializable.toJSON}).
+ * @param date
+ */
+export declare function JSON_NUMBER(num: number): number | null;
+/**
+ *
+ */
+export declare const WEEKDAYS: boolean[];
+/**
+ * Creates an array of 7 boolean values.
+ * Extra values from the input are ignored.
+ * @param days
+ */
+export declare function WEEKDAYS_PARSE(days: string | boolean[]): boolean[];
+/**
+ * Creates as string of 7 characters (either `1` or `0`).
+ */
+export declare function WEEKDAYS_JSON(days: string | boolean[]): string;