Function flatten

  • flatten(object, options?): Record<string, any>

  • Flattens an object into a single-level object with delimited keys.

    Parameters

    • object: object

      The object to flatten

    • options: FlatCopyOptions = {}

      Configuration options for flattening

    Returns Record<string, any>

    A single-level object with flattened keys

    Throws

    Will throw an error if the input is not an object

    Example

    const result = flatten({ a: { b: 1 } });
    // result => { 'a.b': 1 }

Settings

Member Visibility