Options
All
  • Public
  • Public/Protected
  • All
Menu

Module src/object/flat/utils

Index

Functions

Const flatten

  • Following code is a copy from 'flat' library (v5.0.2): @see https://github.com/hughsk/flat. The modifications performed by us is neglible, and is only confined to TS support and ESLint compliance. Note: we haven't reviewed the code to avoid spending time rewriting it.

    Type parameters

    • T

    Parameters

    • target: T

      the object to be flatten

    • Optional opts: FlattenOptions

      extra options to perform flatten

    Returns any

    flatten object

Const isBuffer

  • isBuffer(obj: any): boolean
  • Following code is a copy from 'flat' library (v5.0.2): @see https://github.com/hughsk/flat. The modifications performed by us is neglible, and is only confined to TS support and ESLint compliance. Note: we haven't reviewed the code to avoid spending time rewriting it.

    Parameters

    • obj: any

      the object to be checked as buffer type.

    Returns boolean

    boolean outcome

Const keyIdentity

  • keyIdentity(key: string): string
  • Parameters

    • key: string

    Returns string

Const unflatten

  • Following code is a copy from 'flat' library (v5.0.2): @see https://github.com/hughsk/flat. The modifications performed by us is neglible, and is only confined to TS support and ESLint compliance. Note: we haven't reviewed the code to avoid spending time rewriting it.

    Parameters

    • target: any

      the object to be flatten

    • opts: UnflattenOptions

      extra options to perform flatten

    Returns any

    unflatten object

Generated using TypeDoc