External module "index"

Index

Interfaces

DotGetOptions

Functions

Functions

buildPath

buildPath(tokens: (string | number)[]): string

- Defined in index.ts:512
Build path from Tokens like array

Parameters
- tokens: (string | number)[]
Returns string

containWildcardToken

containWildcardToken(path: string): boolean

- Defined in index.ts:520
Check contains of wildcard syntax

Parameters
- path: string
Returns boolean

escapePath

escapePath(path: string): string

- Defined in index.ts:502
Escape path string

Parameters
- path: string
Returns string

expand

expand(data: any): any

- Defined in index.ts:423
Expand vaules

Parameters
- data: any
Returns any

flatten

flatten(data: any): any

- Defined in index.ts:417
Parameters
- data: any
Returns any

forEach

forEach(data: any, path: DotKey, iteratee: function, options?: DotGetOptions): void

- Defined in index.ts:453
Executes a provided function once for each element.

Parameters
- data: any
- path: DotKey
- iteratee: function
  - - (value: any, key: DotKey, context: any, path: string, data: any | any[]): boolean | void
    - Parameters
      - value: any
      - key: DotKey
      - context: any
      - path: string
      - data: any | any[]
      Returns boolean | void
- Optional options: DotGetOptions
Returns void

get

get(data: any, path: DotKey, value?: any | undefined, options?: DotGetOptions): any

- Defined in index.ts:203
Parameters
- data: any
- path: DotKey
- Default value value: any | undefined = undefined
- Optional options: DotGetOptions
Returns any

has

has(data: any, path: DotKey): boolean

- Defined in index.ts:352
Check value

Parameters
- data: any
- path: DotKey
Returns boolean

map

map(data: any, path: DotKey, iteratee: function, options?: DotGetOptions): any[]

- Defined in index.ts:470
Create a new element with the results of calling a provided function on every element.

Parameters
- data: any
- path: DotKey
- iteratee: function
  - - (value: any, key: DotKey, context: any, path: string, data: any | any[]): any
    - Parameters
      - value: any
      - key: DotKey
      - context: any
      - path: string
      - data: any | any[]
      Returns any
- Optional options: DotGetOptions
Returns any[]

matchPath

matchPath(pathA: string, pathB: string): boolean

- Defined in index.ts:486
Match key

Parameters
- pathA: string
- pathB: string
Returns boolean

remove

remove(data: any, path: DotKey): any

- Defined in index.ts:282
Parameters
- data: any
- path: DotKey
Returns any

set

set(data: any, path: DotKey, value: any): any

- Defined in index.ts:215
Setter

Parameters
- data: any
- path: DotKey
- value: any
Returns any

tokenize

tokenize(str: string): Tokens

- Defined in index.ts:100
Tokenize path string

Parameters
- str: string
Returns Tokens

Generated using TypeDoc