Class AstPath<T>

constructor

• new AstPath<T = any>(value: T): AstPath<T>

  Type Parameters

  • T = any

  Parameters

  • value: T

  Returns AstPath<T>

stack

ancestors

• get ancestors(): T[]

  Returns T[]

grandparent

• get grandparent(): T | null

  Returns T | null

index

• get index(): number | null

  Returns number | null

isFirst

• get isFirst(): boolean

  Returns boolean

isInArray

• get isInArray(): boolean

  Returns boolean

isLast

• get isLast(): boolean

  Returns boolean

isRoot

• get isRoot(): boolean

  Returns boolean

key

• get key(): string | null

  Returns string | null

next

• get next(): T | null

  Returns T | null

node

• get node(): T

  Returns T

parent

• get parent(): T | null

  Returns T | null

previous

• get previous(): T | null

  Returns T | null

root

• get root(): T

  Returns T

siblings

• get siblings(): T[] | null

  Returns T[] | null

call

• call<U>(callback: CallCallback<T, U>): U

  Type Parameters

  • U

  Parameters

  • callback: CallCallback<T, U>

  Returns U

• call<U, P1 extends string | number | symbol | undefined>(
      callback: CallCallback<IndexValue<T, P1>, U>,
      prop1: P1,
  ): U

  Type Parameters

  • U
  • P1 extends string | number | symbol | undefined

  Parameters

  • callback: CallCallback<IndexValue<T, P1>, U>
  • prop1: P1

  Returns U

• call<U, P1 extends string | number | symbol, P2>(
      callback: CallCallback<IndexValue<IndexValue<T, P1>, P2>, U>,
      prop1: P1,
      prop2: P2,
  ): U

  Type Parameters

  • U
  • P1 extends string | number | symbol
  • P2

  Parameters

  • callback: CallCallback<IndexValue<IndexValue<T, P1>, P2>, U>
  • prop1: P1
  • prop2: P2

  Returns U

• call<U, P1 extends string | number | symbol, P2, P3>(
      callback: CallCallback<
          IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>,
          U,
      >,
      prop1: P1,
      prop2: P2,
      prop3: P3,
  ): U

  Type Parameters

  • U
  • P1 extends string | number | symbol
  • P2
  • P3

  Parameters

  • callback: CallCallback<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, U>
  • prop1: P1
  • prop2: P2
  • prop3: P3

  Returns U

• call<U, P1 extends string | number | symbol, P2, P3, P4>(
      callback: CallCallback<
          IndexValue<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, P4>,
          U,
      >,
      prop1: P1,
      prop2: P2,
      prop3: P3,
      prop4: P4,
  ): U

  Type Parameters

  • U
  • P1 extends string | number | symbol
  • P2
  • P3
  • P4

  Parameters

  • callback: CallCallback<
        IndexValue<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, P4>,
        U,
    >
  • prop1: P1
  • prop2: P2
  • prop3: P3
  • prop4: P4

  Returns U

• call<U, P extends PropertyKey>(
      callback: CallCallback<any, U>,
      prop1: P,
      prop2: P,
      prop3: P,
      prop4: P,
      ...props: P[],
  ): U

  Type Parameters

  • U
  • P extends PropertyKey

  Parameters

  • callback: CallCallback<any, U>
  • prop1: P
  • prop2: P
  • prop3: P
  • prop4: P
  • ...props: P[]

  Returns U

callParent

• callParent<U>(callback: (path: this) => U, count?: number): U

  Type Parameters

  • U

  Parameters

  • callback: (path: this) => U
  • Optionalcount: number

  Returns U

each

• each(callback: EachCallback<T>): void

  Parameters

  • callback: EachCallback<T>

  Returns void

• each<P1 extends string | number | symbol | undefined>(
      callback: EachCallback<IndexValue<T, P1>>,
      prop1: P1,
  ): void

  Type Parameters

  • P1 extends string | number | symbol | undefined

  Parameters

  • callback: EachCallback<IndexValue<T, P1>>
  • prop1: P1

  Returns void

• each<P1 extends string | number | symbol, P2>(
      callback: EachCallback<IndexValue<IndexValue<T, P1>, P2>>,
      prop1: P1,
      prop2: P2,
  ): void

  Type Parameters

  • P1 extends string | number | symbol
  • P2

  Parameters

  • callback: EachCallback<IndexValue<IndexValue<T, P1>, P2>>
  • prop1: P1
  • prop2: P2

  Returns void

• each<P1 extends string | number | symbol, P2, P3>(
      callback: EachCallback<
          IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>,
      >,
      prop1: P1,
      prop2: P2,
      prop3: P3,
  ): void

  Type Parameters

  • P1 extends string | number | symbol
  • P2
  • P3

  Parameters

  • callback: EachCallback<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>>
  • prop1: P1
  • prop2: P2
  • prop3: P3

  Returns void

• each<P1 extends string | number | symbol, P2, P3, P4>(
      callback: EachCallback<
          IndexValue<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, P4>,
      >,
      prop1: P1,
      prop2: P2,
      prop3: P3,
      prop4: P4,
  ): void

  Type Parameters

  • P1 extends string | number | symbol
  • P2
  • P3
  • P4

  Parameters

  • callback: EachCallback<IndexValue<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, P4>>
  • prop1: P1
  • prop2: P2
  • prop3: P3
  • prop4: P4

  Returns void

• each(
      callback: EachCallback<any[]>,
      prop1: PropertyKey,
      prop2: PropertyKey,
      prop3: PropertyKey,
      prop4: PropertyKey,
      ...props: PropertyKey[],
  ): void

  Parameters

  • callback: EachCallback<any[]>
  • prop1: PropertyKey
  • prop2: PropertyKey
  • prop3: PropertyKey
  • prop4: PropertyKey
  • ...props: PropertyKey[]

  Returns void

getName

• getName(): PropertyKey | null

  Returns PropertyKey | null

  Deprecated

  Please use AstPath#key or AstPath#index

getNode

• getNode(count?: number): T | null

  Parameters

  • Optionalcount: number

  Returns T | null

getParentNode

• getParentNode(count?: number): T | null

  Parameters

  • Optionalcount: number

  Returns T | null

getValue

• getValue(): T

  Returns T

  Deprecated

  Please use AstPath#node or AstPath#siblings

map

• map<U>(callback: MapCallback<T, U>): U[]

  Type Parameters

  • U

  Parameters

  • callback: MapCallback<T, U>

  Returns U[]

• map<U, P1 extends string | number | symbol | undefined>(
      callback: MapCallback<IndexValue<T, P1>, U>,
      prop1: P1,
  ): U[]

  Type Parameters

  • U
  • P1 extends string | number | symbol | undefined

  Parameters

  • callback: MapCallback<IndexValue<T, P1>, U>
  • prop1: P1

  Returns U[]

• map<U, P1 extends string | number | symbol, P2>(
      callback: MapCallback<IndexValue<IndexValue<T, P1>, P2>, U>,
      prop1: P1,
      prop2: P2,
  ): U[]

  Type Parameters

  • U
  • P1 extends string | number | symbol
  • P2

  Parameters

  • callback: MapCallback<IndexValue<IndexValue<T, P1>, P2>, U>
  • prop1: P1
  • prop2: P2

  Returns U[]

• map<U, P1 extends string | number | symbol, P2, P3>(
      callback: MapCallback<
          IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>,
          U,
      >,
      prop1: P1,
      prop2: P2,
      prop3: P3,
  ): U[]

  Type Parameters

  • U
  • P1 extends string | number | symbol
  • P2
  • P3

  Parameters

  • callback: MapCallback<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, U>
  • prop1: P1
  • prop2: P2
  • prop3: P3

  Returns U[]

• map<U, P1 extends string | number | symbol, P2, P3, P4>(
      callback: MapCallback<
          IndexValue<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, P4>,
          U,
      >,
      prop1: P1,
      prop2: P2,
      prop3: P3,
      prop4: P4,
  ): U[]

  Type Parameters

  • U
  • P1 extends string | number | symbol
  • P2
  • P3
  • P4

  Parameters

  • callback: MapCallback<
        IndexValue<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, P4>,
        U,
    >
  • prop1: P1
  • prop2: P2
  • prop3: P3
  • prop4: P4

  Returns U[]

• map<U>(
      callback: MapCallback<any[], U>,
      prop1: PropertyKey,
      prop2: PropertyKey,
      prop3: PropertyKey,
      prop4: PropertyKey,
      ...props: PropertyKey[],
  ): U[]

  Type Parameters

  • U

  Parameters

  • callback: MapCallback<any[], U>
  • prop1: PropertyKey
  • prop2: PropertyKey
  • prop3: PropertyKey
  • prop4: PropertyKey
  • ...props: PropertyKey[]

  Returns U[]

match

• match(
      ...predicates: (
          (node: any, name: string | null, number: number | null) => boolean
      )[],
  ): boolean

  Parameters

  • ...predicates: ((node: any, name: string | null, number: number | null) => boolean)[]

  Returns boolean