// Tutorial //

Generic Functions in Flow

Published on June 29, 2017
    Default avatar
    By Matthew Garcia
    Developer and author at DigitalOcean.
    Generic Functions in Flow

    While we believe that this content benefits our community, we have not yet thoroughly reviewed it. If you have any suggestions for improvements, please let us know by clicking the “report an issue“ button at the bottom of the tutorial.

    One of the best concepts Flow borrows from Object-Oriented programs is the concept of generics. There are many cases where generics are essential to refining type checks.

    Where are Generics Useful?

    Let’s say you have a function memoize. With Flow types, it might look something like this:

    function memoize(func: (key: any) => any): (key: any) => any {
      const registry = new Map();
      return function(key: any): any {
        let value = registry.get(key);
        if (typeof value === 'undefined') {
          value = func(key);
          registry.set(key, value);
        }
        return value;
      };
    }
    

    The problem is that it will swallow the specifics of func:

    // Type is (val: number) => boolean
    function isPrime(val: number): boolean {
      // Implementation...
    }
    // Type is (key: any) => any
    const memoizedIsPrime = memoize(isPrime);
    // This gives an error, since `Sentinel` is not a number.
    isPrime('Sentinel');
    // This does not give an error, since 'Sentinel' is any.
    memoizedIsPrime('Sentinel');
    

    Making it Generic

    It’s as simple as declaring types in chevrons before the parameters and using those as types:

    // We're using `K` and `V` here for convention, but you can name them pretty much anything.
    export default function memoize<K, V>(func: (key: K) => V): (key: K) => V {
      const registry = new Map();
      return function(key: K): V {
        let value = registry.get(key);
        if (typeof value === 'undefined') {
          value = func(key);
          registry.set(key, value);
        }
        return value;
      };
    }
    

    Flow will infer the rest:

    // Type is (val: number) => boolean
    function isPrime(val: number): boolean {
      // Implementation...
    }
    // Type is (key: K) => V.  Flow infers that `K` is number and `V` is boolean.
    const memoizedIsPrime = memoize(isPrime);
    // This gives an error, since `Sentinel` is not a number.
    isPrime('Sentinel');
    // This gives an error, since 'Sentinel' is a 'K' (number).
    memoizedIsPrime('Sentinel');
    

    Want to learn more? Join the DigitalOcean Community!

    Join our DigitalOcean community of over a million developers for free! Get help and share knowledge in our Questions & Answers section, find tutorials and tools that will help you grow as a developer and scale your project or business, and subscribe to topics of interest.

    Sign up
    About the authors
    Default avatar
    Developer and author at DigitalOcean.

    Still looking for an answer?

    Was this helpful?
    Leave a comment

    This textbox defaults to using Markdown to format your answer.

    You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!