Interfolio API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

References

Type aliases

Variables

Functions

References

default

Renames and exports Utils

Type aliases

DeNestingDef

DeNestingDef: {}

The definition for de nesting a response retrieved from interfolio

Type declaration

  • [key: string]: { nestedAttributeName: string; nestedDefs?: DeNestingDef; type: "DENEST_ARRAY" | "DENEST_CHILD_OBJECT" }
    • nestedAttributeName: string
    • Optional nestedDefs?: DeNestingDef
    • type: "DENEST_ARRAY" | "DENEST_CHILD_OBJECT"

Variables

Const Utils

Utils: { deNest: (data: ApiResponse, deNestingDefs: DeNestingDef) => ApiResponse } = ...

uandle to the functions defined by the utils

Type declaration

Functions

Const deNest

  • Function which takes an object returned from the API and removes unnecessary nesting according the the deNesting definition

    Parameters

    • data: ApiResponse

      Data (or subdata) returned from an API

    • deNestingDefs: DeNestingDef

      Defines which parameters (or subparameters) need to be denested

    Returns ApiResponse

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc