@types/flat

  • Version 5.0.5
  • Published
  • 4.46 kB
  • No dependencies
  • MIT license

Install

npm i @types/flat
yarn add @types/flat
pnpm add @types/flat

Overview

TypeScript definitions for flat

Index

Variables

variable flatten

var flatten: FlatTypes.Flatten;

    Namespaces

    namespace FlatTypes

    namespace FlatTypes {}

      interface Flatten

      interface Flatten {}

        property flatten

        flatten: Flatten;

          property unflatten

          unflatten: Unflatten;

            call signature

            <TTarget, TResult>(target: TTarget, options?: FlattenOptions): TResult;

              interface FlattenOptions

              interface FlattenOptions {}

                property delimiter

                delimiter?: string | undefined;

                  property maxDepth

                  maxDepth?: number | undefined;

                    property safe

                    safe?: boolean | undefined;

                      property transformKey

                      transformKey?: ((key: string) => string) | undefined;

                        interface Unflatten

                        interface Unflatten {}

                          call signature

                          <TTarget, TResult>(target: TTarget, options?: UnflattenOptions): TResult;

                            interface UnflattenOptions

                            interface UnflattenOptions {}

                              property delimiter

                              delimiter?: string | undefined;

                                property object

                                object?: boolean | undefined;

                                  property overwrite

                                  overwrite?: boolean | undefined;

                                    property transformKey

                                    transformKey?: ((key: string) => string) | undefined;

                                      Package Files (1)

                                      Dependencies (0)

                                      No dependencies.

                                      Dev Dependencies (0)

                                      No dev dependencies.

                                      Peer Dependencies (0)

                                      No peer dependencies.

                                      Badge

                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/flat.

                                      • Markdown
                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/flat)
                                      • HTML
                                        <a href="https://www.jsdocs.io/package/@types/flat"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>