curryRecord

timhwang21.gitbook.io

Search…

curryRecord

This is an example of a function whose logic lives in the type definition rather than in the function body.
1
/**
2
 * @name `curryRecord`
3
 *
4
 * Takes a unary function that takes a record as an argument, and makes the
5
 * record partially applicable. Returns a new function that takes a partial of
6
 * the record, which itself returns a new function that takes only the missing
7
 * properties of the record.
8
 *
9
 * Can be thought of as `curry()` that curries a record as opposed to a list of
10
 * arguments.
11
 */
12
export const curryRecord = <F extends (x: Record<any, any>) => any>(fn: F) => <
13
  T extends Partial<Parameters<F>[0]>
14
>(
15
  a: T
16
) => (b: Omit<Parameters<F>[0], keyof T>): ReturnType<F> =>
17
  fn({ ...a, ...b } as Parameters<F>[0]);
Copied!
Breaking it down
export const curryRecord = <F extends (x: Record<any, any>) => any>(fn: F) => ...
The first argument is a unary function. We use the generic <F extends...> to enforce arity and to enforce the passed function's argument being a record. The exact type of x and the return type will be inferred by Typescript once a function is actually passed.
<T extends Partial<Parameters<F>[0]>>(a: T) => ...
Once we pass our unary function we get a new function that takes a: T. T must be assignable to Partial<Parameters<F>[0]>, which means "a partial version of whatever record your unary function expects as an argument."
(b: Omit<Parameters<F>[0], keyof T>): ...
Once we pass our partial record, we get a new function that takes a record b that must contain all keys of Parameters<F>[0] that were NOT included in a. It checks this by omitting all keys of a from Parameters<F>[0]: the remaining keys are the keys that must be passed as a part of b.
ReturnType<F>
The return type of the curried function should match the return type of the function we're currying in the first place. We don't know what this is, so we use ReturnType<F> to infer the proper type once a function is actually passed.
... => fn({ ...a, ...b } as Parameters<F>[0])
We trivially spread both partial arguments into the original function. We have to coerce this here because Typescript can't figure out that the above constraints means that { ...a, ...b } will always be of type Parameters<F>[0].
Interestingly enough, once compiled to Javascript this function becomes curryRecord => fn => a => b => fn({ ...a, ...b }), which does absolutely zero validation. All the logic is handled by the type system!
Demo and test cases
1
interface FooBar {
2
  foo: string;
3
  bar: string;
4
}
5
​
6
const handleFooBar = (foobar: FooBar): string => foobar.foo + foobar.bar;
7
​
8
// Works trivially
9
handleFooBar({
10
  foo: "foo",
11
  bar: "bar"
12
});
13
​
14
// TypeError: Property "bar" is missing
15
handleFooBar({
16
  foo: "foo"
17
});
18
​
19
// Returns a version of handleFooBar ready for partialization
20
const curryRecordHandleFooBar = curryRecord(handleFooBar);
21
​
22
// Returns a function that only allows the missing properties
23
const handleFooBarWithFooProvided = curryRecordHandleFooBar({
24
  foo: "foo"
25
});
26
​
27
// TypeError: "foo" is not assignable to Omit<FooBar, 'foo'>
28
handleFooBarWithFooProvided({ foo: "foo2" });
29
​
30
// TypeError: Property "bar" is missing
31
handleFooBarWithFooProvided({});
32
​
33
// Works!
34
handleFooBarWithFooProvided({ bar: "bar" });
35
​
36
// There are no missing properties, hence this is called with an empty record
37
const handleFooBarWithAllKeysProvided = curryRecordHandleFooBar({
38
  foo: "foo",
39
  bar: "bar"
40
});
41
​
42
handleFooBarWithAllKeysProvided({});
43
​
44
// TypeError: rejects functions that do not take records
45
curryRecord((x: number) => 123);
46
​
47
// TypeError: rejects non-unary functions
48
curryRecord((x: Record<any, any>, y: Record<any, any>) => 123);
Copied!