ngx-transforms 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-transforms",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "A collection of 36 standalone Angular pipes for text, security, media, data, and array transformations.",
   "keywords": [
     "angular",

package/types/ngx-transforms.d.ts

@@ -1048,7 +1048,289 @@ declare class FilterByPipe implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<FilterByPipe, "filterBy", true>;
 }
 
+/**
+ * MinPipe: Returns the minimum value from an array of numbers or objects.
+ *
+ * Supports primitive number arrays and object arrays by property key with dot notation.
+ *
+ * @param {unknown[]} value - The array to evaluate.
+ * @param {string} [key] - Optional property path for object comparison (supports dot notation).
+ *
+ * @returns {number | undefined} - The minimum value, or undefined if the array is empty/invalid.
+ *
+ * @example
+ * {{ [5, 3, 8, 1, 9] | min }}                              // 1
+ * {{ products | min:'price' }}                               // cheapest price
+ * {{ orders | min:'meta.total' }}                            // lowest order total
+ */
+declare class MinPipe implements PipeTransform {
+    transform(value: unknown[], key?: string): number | undefined;
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MinPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<MinPipe, "min", true>;
+}
+
+/**
+ * MaxPipe: Returns the maximum value from an array of numbers or objects.
+ *
+ * Supports primitive number arrays and object arrays by property key with dot notation.
+ *
+ * @param {unknown[]} value - The array to evaluate.
+ * @param {string} [key] - Optional property path for object comparison (supports dot notation).
+ *
+ * @returns {number | undefined} - The maximum value, or undefined if the array is empty/invalid.
+ *
+ * @example
+ * {{ [5, 3, 8, 1, 9] | max }}                              // 9
+ * {{ products | max:'price' }}                               // highest price
+ * {{ orders | max:'meta.total' }}                            // largest order total
+ */
+declare class MaxPipe implements PipeTransform {
+    transform(value: unknown[], key?: string): number | undefined;
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MaxPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<MaxPipe, "max", true>;
+}
+
+/**
+ * SumPipe: Returns the sum of all numeric values in an array.
+ *
+ * Supports primitive number arrays and object arrays by property key with dot notation.
+ *
+ * @param {unknown[]} value - The array to evaluate.
+ * @param {string} [key] - Optional property path for object summation (supports dot notation).
+ *
+ * @returns {number | undefined} - The total, or undefined if the array is empty/invalid.
+ *
+ * @example
+ * {{ [10, 20, 30] | sum }}                                  // 60
+ * {{ items | sum:'price' }}                                  // total price
+ * {{ orders | sum:'meta.total' }}                            // grand total
+ */
+declare class SumPipe implements PipeTransform {
+    transform(value: unknown[], key?: string): number | undefined;
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SumPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<SumPipe, "sum", true>;
+}
+
+/**
+ * AveragePipe: Returns the arithmetic mean of all numeric values in an array.
+ *
+ * Supports primitive number arrays and object arrays by property key with dot notation.
+ *
+ * @param {unknown[]} value - The array to evaluate.
+ * @param {string} [key] - Optional property path for object averaging (supports dot notation).
+ *
+ * @returns {number | undefined} - The average, or undefined if the array is empty/invalid.
+ *
+ * @example
+ * {{ [10, 20, 30] | average }}                              // 20
+ * {{ students | average:'grade' }}                           // average grade
+ * {{ reviews | average:'meta.rating' }}                      // average rating
+ */
+declare class AveragePipe implements PipeTransform {
+    transform(value: unknown[], key?: string): number | undefined;
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AveragePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<AveragePipe, "average", true>;
+}
+
+/**
+ * PercentagePipe: Calculates what percentage a value represents of a total.
+ *
+ * Returns `(value / total) * 100`, optionally rounded to a given number of decimal places.
+ *
+ * @param {number} value - The partial value.
+ * @param {number} total - The total/whole value.
+ * @param {number} [decimals] - Optional number of decimal places to round to.
+ *
+ * @returns {number | undefined} - The percentage, or undefined if inputs are invalid.
+ *
+ * @example
+ * {{ 25 | percentage:200 }}                                 // 12.5
+ * {{ 1 | percentage:3:2 }}                                  // 33.33
+ * {{ 750 | percentage:1000 }}                               // 75
+ */
+declare class PercentagePipe implements PipeTransform {
+    transform(value: number, total: number, decimals?: number): number | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PercentagePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<PercentagePipe, "percentage", true>;
+}
+
+/**
+ * CeilPipe: Rounds a number up to the specified number of decimal places.
+ *
+ * Uses `Math.ceil` — always rounds toward positive infinity.
+ *
+ * @param {number} value - The number to round up.
+ * @param {number} [precision=0] - Number of decimal places to preserve (defaults to 0 = integer).
+ *
+ * @returns {number | undefined} - The rounded-up value, or undefined if the input is invalid.
+ *
+ * @example
+ * {{ 4.1 | ceil }}                                           // 5
+ * {{ 4.123 | ceil:2 }}                                       // 4.13
+ * {{ 0.001 | ceil:2 }}                                       // 0.01
+ * {{ -4.9 | ceil }}                                          // -4
+ */
+declare class CeilPipe implements PipeTransform {
+    transform(value: number, precision?: number): number | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CeilPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<CeilPipe, "ceil", true>;
+}
+
+/**
+ * FloorPipe: Rounds a number down to the specified number of decimal places.
+ *
+ * Uses `Math.floor` — always rounds toward negative infinity.
+ *
+ * @param {number} value - The number to round down.
+ * @param {number} [precision=0] - Number of decimal places to preserve (defaults to 0 = integer).
+ *
+ * @returns {number | undefined} - The rounded-down value, or undefined if the input is invalid.
+ *
+ * @example
+ * {{ 4.9 | floor }}                                          // 4
+ * {{ 4.567 | floor:2 }}                                      // 4.56
+ * {{ 0.999 | floor:1 }}                                      // 0.9
+ * {{ -4.1 | floor }}                                         // -5
+ */
+declare class FloorPipe implements PipeTransform {
+    transform(value: number, precision?: number): number | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FloorPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<FloorPipe, "floor", true>;
+}
+
+/**
+ * RoundPipe: Rounds a number to the nearest value at the specified number of decimal places.
+ *
+ * Uses `Math.round` — rounds half-up (e.g. 2.5 → 3, -2.5 → -2).
+ *
+ * @param {number} value - The number to round.
+ * @param {number} [precision=0] - Number of decimal places to preserve (defaults to 0 = integer).
+ *
+ * @returns {number | undefined} - The rounded value, or undefined if the input is invalid.
+ *
+ * @example
+ * {{ 4.4 | round }}                                          // 4
+ * {{ 4.5 | round }}                                          // 5
+ * {{ 4.567 | round:2 }}                                      // 4.57
+ * {{ 0.125 | round:2 }}                                      // 0.13
+ */
+declare class RoundPipe implements PipeTransform {
+    transform(value: number, precision?: number): number | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RoundPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<RoundPipe, "round", true>;
+}
+
+/**
+ * SqrtPipe: Returns the square root of a number.
+ *
+ * Uses `Math.sqrt`. Returns undefined for negative numbers.
+ *
+ * @param {number} value - The number to compute the square root of.
+ *
+ * @returns {number | undefined} - The square root, or undefined if the input is invalid or negative.
+ *
+ * @example
+ * {{ 9 | sqrt }}                                             // 3
+ * {{ 2 | sqrt }}                                             // 1.4142135623730951
+ * {{ 144 | sqrt }}                                           // 12
+ */
+declare class SqrtPipe implements PipeTransform {
+    transform(value: number): number | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SqrtPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<SqrtPipe, "sqrt", true>;
+}
+
+/**
+ * PowPipe: Raises a number to the specified power.
+ *
+ * Uses `Math.pow`. The exponent defaults to 2 (squaring).
+ *
+ * @param {number} value - The base number.
+ * @param {number} [exponent=2] - The power to raise the base to (defaults to 2).
+ *
+ * @returns {number | undefined} - The result, or undefined if the inputs are invalid.
+ *
+ * @example
+ * {{ 3 | pow }}                                              // 9  (3^2)
+ * {{ 2 | pow:3 }}                                            // 8  (2^3)
+ * {{ 5 | pow:0 }}                                            // 1  (anything^0)
+ */
+declare class PowPipe implements PipeTransform {
+    transform(value: number, exponent?: number): number | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PowPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<PowPipe, "pow", true>;
+}
+
+/**
+ * DegreesPipe: Converts a value in radians to degrees.
+ *
+ * Formula: `degrees = radians * (180 / Math.PI)`
+ *
+ * @param {number} value - The angle in radians.
+ *
+ * @returns {number | undefined} - The angle in degrees, or undefined if the input is invalid.
+ *
+ * @example
+ * {{ 3.14159 | degrees }}                                    // ~180
+ * {{ 1.5708 | degrees }}                                     // ~90
+ * {{ 0 | degrees }}                                          // 0
+ */
+declare class DegreesPipe implements PipeTransform {
+    transform(value: number): number | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DegreesPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<DegreesPipe, "degrees", true>;
+}
+
+/**
+ * BytesPipe: Formats a number of bytes into a human-readable string with appropriate units.
+ *
+ * Supports both binary (1024-based: KiB, MiB, GiB) and decimal (1000-based: KB, MB, GB) units.
+ * Defaults to decimal (1000-based) units.
+ *
+ * @param {number} value - The number of bytes.
+ * @param {number} [decimals=1] - Number of decimal places in the output.
+ * @param {string} [base='decimal'] - Unit base: 'decimal' (1000, KB/MB/GB) or 'binary' (1024, KiB/MiB/GiB).
+ *
+ * @returns {string | undefined} - The formatted string, or undefined if the input is invalid.
+ *
+ * @example
+ * {{ 1536 | bytes }}                                         // "1.5 KB"
+ * {{ 1048576 | bytes:2 }}                                    // "1.05 MB"
+ * {{ 1073741824 | bytes:1:'binary' }}                        // "1.0 GiB"
+ */
+declare class BytesPipe implements PipeTransform {
+    private readonly decimalUnits;
+    private readonly binaryUnits;
+    transform(value: number, decimals?: number, base?: 'decimal' | 'binary'): string | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BytesPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<BytesPipe, "bytes", true>;
+}
+
+/**
+ * RadiansPipe: Converts a value in degrees to radians.
+ *
+ * Formula: `radians = degrees * (Math.PI / 180)`
+ *
+ * @param {number} value - The angle in degrees.
+ *
+ * @returns {number | undefined} - The angle in radians, or undefined if the input is invalid.
+ *
+ * @example
+ * {{ 180 | radians }}                                        // ~3.14159
+ * {{ 90 | radians }}                                         // ~1.5708
+ * {{ 0 | radians }}                                          // 0
+ */
+declare class RadiansPipe implements PipeTransform {
+    transform(value: number): number | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RadiansPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<RadiansPipe, "radians", true>;
+}
+
 declare const ALL_PIPES: Provider[];
 
-export { ALL_PIPES, AsciiArtPipe, BarcodePipe, CamelCasePipe, ChunkPipe, ColorConvertPipe, CountPipe, CreditCardMaskPipe, DeviceTypePipe, DiffPipe, EmailMaskPipe, EveryPipe, FilterByPipe, Flatten, GravatarPipe, GroupByPipe, HighlightPipe, HtmlEscapePipe, HtmlSanitizePipe, InitialPipe, InitialsPipe, IntersectionPipe, IpAddressMaskPipe, JsonPrettyPipe, KebabCasePipe, MorseCodePipe, OrderByPipe, PluckPipe, QrCodePipe, RangePipe, ReplacePipe, ReversePipe, SamplePipe, ShufflePipe, SnakeCasePipe, SomePipe, TailPipe, TextToSpeechPipe, TimeAgoPipePipe, TitleCasePipe, TruncatePipe, TruthifyPipe, UnionPipe, UniquePipe, WithoutPipe };
+export { ALL_PIPES, AsciiArtPipe, AveragePipe, BarcodePipe, BytesPipe, CamelCasePipe, CeilPipe, ChunkPipe, ColorConvertPipe, CountPipe, CreditCardMaskPipe, DegreesPipe, DeviceTypePipe, DiffPipe, EmailMaskPipe, EveryPipe, FilterByPipe, Flatten, FloorPipe, GravatarPipe, GroupByPipe, HighlightPipe, HtmlEscapePipe, HtmlSanitizePipe, InitialPipe, InitialsPipe, IntersectionPipe, IpAddressMaskPipe, JsonPrettyPipe, KebabCasePipe, MaxPipe, MinPipe, MorseCodePipe, OrderByPipe, PercentagePipe, PluckPipe, PowPipe, QrCodePipe, RadiansPipe, RangePipe, ReplacePipe, ReversePipe, RoundPipe, SamplePipe, ShufflePipe, SnakeCasePipe, SomePipe, SqrtPipe, SumPipe, TailPipe, TextToSpeechPipe, TimeAgoPipePipe, TitleCasePipe, TruncatePipe, TruthifyPipe, UnionPipe, UniquePipe, WithoutPipe };
 export type { AsciiArtOptions, BarcodeElementType, BarcodeFormat, BarcodeOptions, ColorTargetType, DeviceType, QrCodeOptions };