import { BatchLoader } from 'batchloader';
 
const userLoader = new BatchLoader(
  (_ids: ObjectId[]) => User.getByIds(_ids), // [required] batch function.
  (_id: ObjectId) => _id.toString(), // [optional] key to unique id function. must return string. used for finding duplicate keys.
  100 // [optional = 0] batch delay in ms. default 0 ms.
);
 
const user1 = await userLoader.load(id1);
 
const [user1, user2] = await userLoader.loadMany([id1, id2]);
 
const [user1, user1, user1] = await userLoader.loadMany([id1, id1, id1]); // batch function receives only one id1 since duplicate ids. Still returs three items just as requested.
 
const [user1, user2, user3, user2, user1] = await Promise.all([
  userLoader.load(id1),
  userLoader.load(id2),
  userLoader.load(id3),
  userLoader.load(id2),
  userLoader.load(id1),
]); // batch function receives [id1, id2, id3] only without duplicate ids.

(keys: Key[]) => Value[] | Promise<Value[]> // keys.length === values.length

(key: Key) => string

const loader = new BatchLoader(
  (keys: Key[]) => loadValues(keys),
  null // keys cannot be transformed into string. no duplicates filtering.
);
const v1 = await loader.load(k1);
const [v1, v2, v1] = await loader.loadMany([k1, k2, k1]); // batch function receives [k1, k2, k1] as keys

import { MappedBatchLoader } from 'batchloader';
 
const getUsername = (user) => user && user.username;
 
const usernameLoader = userLoader.mapLoader(getUsername);
// or
const usernameLoader = new MappedBatchLoader(userLoader, getUsername);
 
// same APIs as BatchLoader
const username = await usernameLoader.load(userId);
const [username1, username2] = await usernameLoader.loadMany([userId1, userId2]);
const [user1, username1] = await Promise.all([
  userLoader.load(id1),
  usernameLoader.load(id1),
]) // one round-trip request with keys being [id1], since usernameLoader is using userLoader internally and id1 is duplicate.
 
const anotherMappedLoader = usernameLoader.mapLoader(mapFn);
// or
const anotherMappedLoader = new MappedBatchLoader(usernameLoader, mapFn);

let userCache = {};
 
const cachedUserLoader = new BatchLoader(
  async (ids) => {
    const uncachedIds = ids.filter(id => !userCache[id]);
    const users = await getUsersByIds(uncachedIds);
    uncachedIds.forEach((id, i) => { userCache[id] = users[i]; });
    return ids.map(id => userCache[id]);
  },
  ...
);
 
delete userCache[id1]; // delete cache by key
userCache[id2] = user2; // add cache by key
userCache = {}; // empty cache