releas 2.2.3

CHANGELOG.md

@@ -1,5 +1,11 @@
 # dataloader
 
+## 2.2.3
+
+### Patch Changes
+
+- [#342](https://github.com/graphql/dataloader/pull/342) [`38fedd4`](https://github.com/graphql/dataloader/commit/38fedd4106e9e3e7eb77bd68e42abc088110bd43) Thanks [@abendi](https://github.com/abendi)! - Ensure `cacheKeyFn` is not called when caching is disabled, since the key is not utilized in that case.
+
 ## 2.2.2
 
 ### Patch Changes

index.d.ts

@@ -0,0 +1,138 @@
+/**
+ * Copyright (c) 2019-present, GraphQL Foundation
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * DataLoader creates a public API for loading data from a particular
+ * data back-end with unique keys such as the id column of a SQL table
+ * or document name in a MongoDB database, given a batch loading function.
+ *
+ * Each DataLoader instance contains a unique memoized cache. Use caution
+ * when used in long-lived applications or those which serve many users
+ * with different access permissions and consider creating a new instance
+ * per web request.
+ */
+declare class DataLoader<K, V, C = K> {
+  constructor(
+    batchLoadFn: DataLoader.BatchLoadFn<K, V>,
+    options?: DataLoader.Options<K, V, C>,
+  );
+
+  /**
+   * Loads a key, returning a `Promise` for the value represented by that key.
+   */
+  load(key: K): Promise<V>;
+
+  /**
+   * Loads multiple keys, promising an array of values:
+   *
+   *     var [ a, b ] = await myLoader.loadMany([ 'a', 'b' ]);
+   *
+   * This is equivalent to the more verbose:
+   *
+   *     var [ a, b ] = await Promise.all([
+   *       myLoader.load('a'),
+   *       myLoader.load('b')
+   *     ]);
+   *
+   */
+  loadMany(keys: ArrayLike<K>): Promise<Array<V | Error>>;
+
+  /**
+   * Clears the value at `key` from the cache, if it exists. Returns itself for
+   * method chaining.
+   */
+  clear(key: K): this;
+
+  /**
+   * Clears the entire cache. To be used when some event results in unknown
+   * invalidations across this particular `DataLoader`. Returns itself for
+   * method chaining.
+   */
+  clearAll(): this;
+
+  /**
+   * Adds the provided key and value to the cache. If the key already exists, no
+   * change is made. Returns itself for method chaining.
+   */
+  prime(key: K, value: V | PromiseLike<V> | Error): this;
+
+
+  /**
+   * The name given to this `DataLoader` instance. Useful for APM tools.
+   *
+   * Is `null` if not set in the constructor.
+   */
+  name: string | null;
+}
+
+declare namespace DataLoader {
+  // If a custom cache is provided, it must be of this type (a subset of ES6 Map).
+  export type CacheMap<K, V> = {
+    get(key: K): V | void;
+    set(key: K, value: V): any;
+    delete(key: K): any;
+    clear(): any;
+  };
+
+  // A Function, which when given an Array of keys, returns a Promise of an Array
+  // of values or Errors.
+  export type BatchLoadFn<K, V> = (
+    keys: ReadonlyArray<K>,
+  ) => PromiseLike<ArrayLike<V | Error>>;
+
+  // Optionally turn off batching or caching or provide a cache key function or a
+  // custom cache instance.
+  export type Options<K, V, C = K> = {
+    /**
+     * Default `true`. Set to `false` to disable batching, invoking
+     * `batchLoadFn` with a single load key. This is equivalent to setting
+     * `maxBatchSize` to `1`.
+     */
+    batch?: boolean;
+
+    /**
+     * Default `Infinity`. Limits the number of items that get passed in to the
+     * `batchLoadFn`. May be set to `1` to disable batching.
+     */
+    maxBatchSize?: number;
+
+    /**
+     * Default see https://github.com/graphql/dataloader#batch-scheduling.
+     * A function to schedule the later execution of a batch. The function is
+     * expected to call the provided callback in the immediate future.
+     */
+    batchScheduleFn?: (callback: () => void) => void;
+
+    /**
+     * Default `true`. Set to `false` to disable memoization caching, creating a
+     * new Promise and new key in the `batchLoadFn` for every load of the same
+     * key. This is equivalent to setting `cacheMap` to `null`.
+     */
+    cache?: boolean;
+
+    /**
+     * Default `key => key`. Produces cache key for a given load key. Useful
+     * when keys are objects and two objects should be considered equivalent.
+     */
+    cacheKeyFn?: (key: K) => C;
+
+    /**
+     * Default `new Map()`. Instance of `Map` (or an object with a similar API)
+     * to be used as cache. May be set to `null` to disable caching.
+     */
+    cacheMap?: CacheMap<C, Promise<V>> | null;
+
+    /**
+     * The name given to this `DataLoader` instance. Useful for APM tools.
+     *
+     * Is `null` if not set in the constructor.
+     */
+    name?: string | null;
+  };
+}
+
+export = DataLoader;