@types/d3-array - npm Package Compare versions

Comparing version 1.2.6 to 2.0.0

d3-array/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for D3JS d3-array module 1.2
+// Type definitions for D3JS d3-array module 2.0
 // Project: https://github.com/d3/d3-array, https://d3js.org/d3-array
@@ -6,7 +6,8 @@ // Definitions by: Alex Ford <https://github.com/gustavderdrache>
 //                 Tom Wanzek <https://github.com/tomwanzek>
-//                 denisname <https://github.com/denisname>
+//                 denisname <https://github.com/denisname>,
+//                 Hugues Stefanski <https://github.com/ledragon>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 2.3
 
-// Last module patch version validated against: 1.2.1
+// Last module patch version validated against: 2.0.3
 
@@ -36,3 +37,3 @@ // --------------------------------------------------------------------------
  */
-export function max(array: ArrayLike<string>): string | undefined;
+export function max(array: Iterable<string>): string | undefined;
 
@@ -42,3 +43,3 @@ /**
  */
-export function max<T extends Numeric>(array: ArrayLike<T>): T | undefined;
+export function max<T extends Numeric>(array: Iterable<T>): T | undefined;
 
@@ -48,3 +49,3 @@ /**
  */
-export function max<T>(array: ArrayLike<T>, accessor: (datum: T, index: number, array: ArrayLike<T>) => string | undefined | null): string | undefined;
+export function max<T>(array: Iterable<T>, accessor: (datum: T, index: number, array: Iterable<T>) => string | undefined | null): string | undefined;
 
@@ -54,3 +55,3 @@ /**
  */
-export function max<T, U extends Numeric>(array: ArrayLike<T>, accessor: (datum: T, index: number, array: ArrayLike<T>) => U | undefined | null): U | undefined;
+export function max<T, U extends Numeric>(array: Iterable<T>, accessor: (datum: T, index: number, array: Iterable<T>) => U | undefined | null): U | undefined;
 
@@ -60,3 +61,3 @@ /**
  */
-export function min(array: ArrayLike<string>): string | undefined;
+export function min(array: Iterable<string>): string | undefined;
 
@@ -66,3 +67,3 @@ /**
  */
-export function min<T extends Numeric>(array: ArrayLike<T>): T | undefined;
+export function min<T extends Numeric>(array: Iterable<T>): T | undefined;
 
@@ -72,3 +73,3 @@ /**
  */
-export function min<T>(array: ArrayLike<T>, accessor: (datum: T, index: number, array: ArrayLike<T>) => string | undefined | null): string | undefined;
+export function min<T>(array: Iterable<T>, accessor: (datum: T, index: number, array: Iterable<T>) => string | undefined | null): string | undefined;
 
@@ -78,3 +79,3 @@ /**
  */
-export function min<T, U extends Numeric>(array: ArrayLike<T>, accessor: (datum: T, index: number, array: ArrayLike<T>) => U | undefined | null): U | undefined;
+export function min<T, U extends Numeric>(array: Iterable<T>, accessor: (datum: T, index: number, array: Iterable<T>) => U | undefined | null): U | undefined;
 
@@ -84,3 +85,3 @@ /**
  */
-export function extent(array: ArrayLike<string>): [string, string] | [undefined, undefined];
+export function extent(array: Iterable<string>): [string, string] | [undefined, undefined];
 
@@ -90,3 +91,3 @@ /**
  */
-export function extent<T extends Numeric>(array: ArrayLike<T>): [T, T] | [undefined, undefined];
+export function extent<T extends Numeric>(array: Iterable<T>): [T, T] | [undefined, undefined];
 
@@ -96,3 +97,3 @@ /**
  */
-export function extent<T>(array: ArrayLike<T>, accessor: (datum: T, index: number, array: ArrayLike<T>) => string | undefined | null): [string, string] | [undefined, undefined];
+export function extent<T>(array: Iterable<T>, accessor: (datum: T, index: number, array: Iterable<T>) => string | undefined | null): [string, string] | [undefined, undefined];
 
@@ -102,3 +103,3 @@ /**
  */
-export function extent<T, U extends Numeric>(array: ArrayLike<T>, accessor: (datum: T, index: number, array: ArrayLike<T>) => U | undefined | null): [U, U] | [undefined, undefined];
+export function extent<T, U extends Numeric>(array: Iterable<T>, accessor: (datum: T, index: number, array: Iterable<T>) => U | undefined | null): [U, U] | [undefined, undefined];
 
@@ -108,3 +109,3 @@ /**
  */
-export function mean<T extends Numeric>(array: ArrayLike<T | undefined | null>): number | undefined;
+export function mean<T extends Numeric>(array: Iterable<T | undefined | null>): number | undefined;
 
@@ -114,3 +115,3 @@ /**
  */
-export function mean<T>(array: ArrayLike<T>, accessor: (datum: T, index: number, array: ArrayLike<T>) => number | undefined | null): number | undefined;
+export function mean<T>(array: Iterable<T>, accessor: (datum: T, index: number, array: Iterable<T>) => number | undefined | null): number | undefined;
 
@@ -120,3 +121,3 @@ /**
  */
-export function median<T extends Numeric>(array: ArrayLike<T | undefined | null>): number | undefined;
+export function median<T extends Numeric>(array: Iterable<T | undefined | null>): number | undefined;
 
@@ -126,3 +127,3 @@ /**
  */
-export function median<T>(array: ArrayLike<T>, accessor: (element: T, i: number, array: ArrayLike<T>) => number | undefined | null): number | undefined;
+export function median<T>(array: Iterable<T>, accessor: (element: T, i: number, array: Iterable<T>) => number | undefined | null): number | undefined;
 
@@ -132,5 +133,5 @@ /**
  */
-export function quantile<T extends Numeric>(array: ArrayLike<T | undefined | null>, p: number): number | undefined;
+export function quantile<T extends Numeric>(array: Iterable<T | undefined | null>, p: number): number | undefined;
 
-export function quantile<T>(array: ArrayLike<T>, p: number, accessor: (element: T, i: number, array: ArrayLike<T>) => number | undefined | null): number | undefined;
+export function quantile<T>(array: Iterable<T>, p: number, accessor: (element: T, i: number, array: Iterable<T>) => number | undefined | null): number | undefined;
 
@@ -140,3 +141,3 @@ /**
  */
-export function sum<T extends Numeric>(array: ArrayLike<T | undefined | null>): number;
+export function sum<T extends Numeric>(array: Iterable<T | undefined | null>): number;
 
@@ -146,3 +147,3 @@ /**
  */
-export function sum<T>(array: ArrayLike<T>, accessor: (datum: T, index: number, array: ArrayLike<T>) => number | undefined | null): number;
+export function sum<T>(array: Iterable<T>, accessor: (datum: T, index: number, array: Iterable<T>) => number | undefined | null): number;
 
@@ -152,3 +153,3 @@ /**
  */
-export function deviation<T extends Numeric>(array: ArrayLike<T | undefined | null>): number | undefined;
+export function deviation<T extends Numeric>(array: Iterable<T | undefined | null>): number | undefined;
 
@@ -159,3 +160,3 @@ /**
  */
-export function deviation<T>(array: ArrayLike<T>, accessor: (datum: T, index: number, array: ArrayLike<T>) => number | undefined | null): number | undefined;
+export function deviation<T>(array: Iterable<T>, accessor: (datum: T, index: number, array: Iterable<T>) => number | undefined | null): number | undefined;
 
@@ -165,3 +166,3 @@ /**
  */
-export function variance<T extends Numeric>(array: ArrayLike<T | undefined | null>): number | undefined;
+export function variance<T extends Numeric>(array: Iterable<T | undefined | null>): number | undefined;
 
@@ -172,3 +173,3 @@ /**
  */
-export function variance<T>(array: ArrayLike<T>, accessor: (datum: T, index: number, array: ArrayLike<T>) => number | undefined | null): number | undefined;
+export function variance<T>(array: Iterable<T>, accessor: (datum: T, index: number, array: Iterable<T>) => number | undefined | null): number | undefined;
 
@@ -179,4 +180,4 @@ // --------------------------------------------------------------------------------------
 
-export function scan(array: ArrayLike<number>, comparator?: (a: number, b: number) => number): number | undefined;
-export function scan<T>(array: ArrayLike<T>, comparator: (a: T, b: T) => number): number | undefined;
+export function scan(array: Iterable<number>, comparator?: (a: number, b: number) => number): number | undefined;
+export function scan<T>(array: Iterable<T>, comparator: (a: T, b: T) => number): number | undefined;
 
@@ -201,2 +202,40 @@ export function bisectLeft(array: ArrayLike<number>, x: number, lo?: number, hi?: number): number;
 
+/**
+ * Rearranges items so that all items in the [left, k] are the smallest. The k-th element will have the (k - left + 1)-th smallest value in [left, right].
+ *
+ * @param array The array to partially sort (in place).
+ * @param k The middle index for partial sorting.
+ */
+export function quickselect<T>(array: ArrayLike<T>, k: number): T[];
+
+/**
+ * Rearranges items so that all items in the [left, k] are the smallest. The k-th element will have the (k - left + 1)-th smallest value in [left, right].
+ *
+ * @param array The array to partially sort (in place).
+ * @param k The middle index for partial sorting.
+ * @param left The left index of the range to sort.
+ */
+export function quickselect<T>(array: ArrayLike<T>, k: number, left: number): T[];
+
+/**
+ * Rearranges items so that all items in the [left, k] are the smallest. The k-th element will have the (k - left + 1)-th smallest value in [left, right].
+ *
+ * @param array The array to partially sort (in place).
+ * @param k The middle index for partial sorting.
+ * @param left The left index of the range to sort.
+ * @param right The right index.
+ */
+export function quickselect<T>(array: ArrayLike<T>, k: number, left: number, right: number): T[];
+
+/**
+ * Rearranges items so that all items in the [left, k] are the smallest. The k-th element will have the (k - left + 1)-th smallest value in [left, right].
+ *
+ * @param array The array to partially sort (in place).
+ * @param k The middle index for partial sorting.
+ * @param left The left index of the range to sort.
+ * @param right The right index.
+ * @param compare The compare function.
+ */
+export function quickselect<T>(array: ArrayLike<T>, k: number, left: number, right: number, compare: (a: Primitive | undefined, b: Primitive | undefined) => number): T[];
+
 // NB. this is limited to primitive values due to D3's use of the <, >, and >= operators. Results get weird for object instances.
@@ -219,2 +258,18 @@ /**
 /**
+ * Groups the specified array of values into a Map from key to array of value.
+ * @param a The array to group.
+ * @param key The key function.
+ */
+export function group<TObject, TKey>(a: Iterable<TObject>, key: (value: TObject) => TKey): Map<TKey, TObject[]>;
+
+/**
+ * Groups and reduces the specified array of values into a Map from key to value.
+ *
+ * @param a The array to group.
+ * @param reduce The reduce function.
+ * @param key The key function.
+ */
+export function rollup<TObject, TKey, TReduce>(a: Iterable<TObject>, reduce: (value: TObject[]) => TReduce, key: (value: TObject) => TKey): Map<TKey, TReduce>;
+
+/**
  * Returns the Cartesian product of the two arrays a and b.
@@ -227,3 +282,3 @@ * For each element i in the specified array a and each element j in the specified array b, in order,
  */
-export function cross<S, T>(a: ArrayLike<S>, b: ArrayLike<T>): Array<[S, T]>;
+export function cross<S, T>(a: Iterable<S>, b: Iterable<T>): Array<[S, T]>;
 
@@ -239,3 +294,3 @@ /**
  */
-export function cross<S, T, U>(a: ArrayLike<S>, b: ArrayLike<T>, reducer: (a: S, b: T) => U): U[];
+export function cross<S, T, U>(a: Iterable<S>, b: Iterable<T>, reducer: (a: S, b: T) => U): U[];
 
@@ -245,3 +300,3 @@ /**
  */
-export function merge<T>(arrays: ArrayLike<ArrayLike<T>>): T[];
+export function merge<T>(arrays: Iterable<Iterable<T>>): T[];
 
@@ -254,3 +309,3 @@ /**
  */
-export function pairs<T>(array: ArrayLike<T>): Array<[T, T]>;
+export function pairs<T>(array: Iterable<T>): Array<[T, T]>;
 /**
@@ -264,3 +319,3 @@ * For each adjacent pair of elements in the specified array, in order, invokes the specified reducer function passing the element i and element i - 1.
  */
-export function pairs<T, U>(array: ArrayLike<T>, reducer: (a: T, b: T) => U): U[];
+export function pairs<T, U>(array: Iterable<T>, reducer: (a: T, b: T) => U): U[];
 
@@ -386,32 +441,2 @@ /**
 
-/**
- * @deprecated Use ThresholdNumberArrayGenerator or ThresholdDateArrayGenerator.
- */
-export type ThresholdArrayGenerator = ThresholdNumberArrayGenerator<number>;
-
-/**
- * @deprecated Use `HistogramGeneratorNumber<Datum, Value>` for `number` values and `HistogramGeneratorDate<Datum, Value> for `Date` values.
- */
-export interface HistogramGenerator<Datum, Value extends number | Date | undefined> {
-    (data: ArrayLike<Datum>): Array<Bin<Datum, Value>>;
-
-    value(): (d: Datum, i: number, data: ArrayLike<Datum>) => Value;
-    value(valueAccessor: (d: Datum, i: number, data: ArrayLike<Datum>) => Value): this;
-
-    domain(): (values: ArrayLike<Value>) => [Value, Value] | [undefined, undefined];
-    domain(domain: [Value, Value]): this;
-    domain(domainAccessor: (values: ArrayLike<Value>) => [Value, Value] | [undefined, undefined]): this;
-
-    /**
-     * Set the array of values to be used as thresholds in determining the bins.
-     *
-     * Any threshold values outside the domain are ignored. The first bin.x0 is always equal to the minimum domain value,
-     * and the last bin.x1 is always equal to the maximum domain value.
-     *
-     * @param thresholds Array of threshold values used for binning. The elements must
-     * be of the same type as the materialized values of the histogram.
-     */
-    thresholds(thresholds: ArrayLike<Value>): this;
-}
-
 export interface HistogramCommon<Datum, Value extends number | Date | undefined> {
@@ -455,5 +480,5 @@ (data: ArrayLike<Datum>): Array<Bin<Datum, Value>>;
 export interface HistogramGeneratorNumber<Datum, Value extends number | undefined> extends HistogramCommon<Datum, Value> {
-    domain(): (values: ArrayLike<Value>) => [number, number] | [undefined, undefined];
+    domain(): (values: Iterable<Value>) => [number, number] | [undefined, undefined];
     domain(domain: [number, number]): this;
-    domain(domainAccessor: (values: ArrayLike<Value>) => [number, number] | [undefined, undefined]): this;
+    domain(domainAccessor: (values: Iterable<Value>) => [number, number] | [undefined, undefined]): this;
 
@@ -512,8 +537,2 @@ thresholds(): ThresholdCountGenerator<Value> | ThresholdNumberArrayGenerator<Value>;
 
-/**
- * @deprecated Do not use Value generic which mixes number and Date types. Use either number or Date
- * (in combination with undefined, as applicable) to obtain a type-specific histogram generator.
- */
-export function histogram<Datum, Value extends number | Date | undefined>(): HistogramGenerator<Datum, Value>;
-
 // --------------------------------------------------------------------------------------
@@ -520,0 +539,0 @@ // Histogram Thresholds

d3-array/package.json

 {
     "name": "@types/d3-array",
-    "version": "1.2.6",
+    "version": "2.0.0",
     "description": "TypeScript definitions for D3JS d3-array module",
@@ -26,2 +26,7 @@ "license": "MIT",
             "githubUsername": "denisname"
+        },
+        {
+            "name": "Hugues Stefanski",
+            "url": "https://github.com/ledragon",
+            "githubUsername": "ledragon"
         }
@@ -33,8 +38,9 @@ ],
         "type": "git",
-        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git"
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/d3-array"
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "ba44676f8632cecc37c1db2c29973b02e328bbdb64c05dbc7308e05bf97f21a8",
+    "typesPublisherContentHash": "ee5e70bc5faa038f317b93cea94776fa6c3e81a3a8a52d01e3931ba49b12271b",
     "typeScriptVersion": "2.3"
 }

d3-array/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Wed, 13 Feb 2019 16:51:59 GMT
+ * Last updated: Wed, 03 Apr 2019 18:23:30 GMT
  * Dependencies: none
@@ -17,2 +17,2 @@ * Global values: none
 # Credits
-These definitions were written by Alex Ford <https://github.com/gustavderdrache>, Boris Yankov <https://github.com/borisyankov>, Tom Wanzek <https://github.com/tomwanzek>, denisname <https://github.com/denisname>.
+These definitions were written by Alex Ford <https://github.com/gustavderdrache>, Boris Yankov <https://github.com/borisyankov>, Tom Wanzek <https://github.com/tomwanzek>, denisname <https://github.com/denisname>, Hugues Stefanski <https://github.com/ledragon>.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

27250

increased by3.68%

Lines of code

436

increased by4.56%

No dependency changes