Rush StackShopBlogEvents
Skip to main content

Home > @rushstack/lookup-by-path > IGetFirstDifferenceInCommonNodesOptions

IGetFirstDifferenceInCommonNodesOptions interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Options for the getFirstDifferenceInCommonNodes function.

Signature:

export interface IGetFirstDifferenceInCommonNodesOptions<TItem extends {}> 

Properties

Property

Modifiers

Type

Description

delimiter?

string

(BETA) (Optional) The delimiter used to join path segments.

equals?

(a: TItem, b: TItem) => boolean

(BETA) (Optional) A function to compare the values of the nodes. If not provided, strict equality (===) is used.

first

IReadonlyPathTrieNode<TItem>

(BETA) The first node to compare.

prefix?

string

(BETA) (Optional) The path prefix to the current node.

second

IReadonlyPathTrieNode<TItem>

(BETA) The second node to compare.