Variable tryHeadN`Const`

tryHeadN: {
<A>(self: Zipper.Zipper<A>, n: number): Option<Zipper.Zipper<A>>;
(n: number): <A>(self: Zipper.Zipper<A>) => Option<Zipper.Zipper<A>>;
} = ...

Navigate from a node to its first child N times to reach the Nth level of the tree, or return Option.none if there is a leaf on the path from root to its Nth 1st child down.

When n is zero, the zipper is returned unchanged.

Will return Option.none if given negative indexes.

See headN for an unsafe version.

Type Declaration

- <A>(self: Zipper.Zipper<A>, n: number): Option<Zipper.Zipper<A>>
- Type Parameters
  - A
  Parameters
  - self: Zipper.Zipper<A>
  - n: number
  Returns Option<Zipper.Zipper<A>>
- (n: number): <A>(self: Zipper.Zipper<A>) => Option<Zipper.Zipper<A>>
- Parameters
  - n: number
  Returns <A>(self: Zipper.Zipper<A>) => Option<Zipper.Zipper<A>>

Type Param: A

The underlying type of the tree.

Param: self

The zipper that will be navigated.

Param: n

Number of tree levels to descend.

Returns

An updated zipper pointing at a new focus or Option.none() if the path to the Nth level is not valid.

Variable tryHeadNConst

Type Declaration

Type Parameters

Parameters

Returns Option<Zipper.Zipper<A>>