tree

Interfaces

TreeMapRecordAsyncConfig

Defined in: tree/index.ts:218

Type Parameters

Type Parameter
`TIn`
`TOut`
`TCtx`

Properties

mapChildEntry

mapChildEntry: (key, child, ctx) => Promise<
  | {
  childCtx: TCtx;
  key: string;
}
| null>;

Defined in: tree/index.ts:220

Parameters

Parameter	Type
`key`	`string`
`child`	`TIn`
`ctx`	`TCtx`

Returns

Promise< | { childCtx: TCtx; key: string; } | null>

mapNode

mapNode: (node, ctx, isRoot) => Promise<Omit<TOut, "include">>;

Defined in: tree/index.ts:219

Parameters

Parameter	Type
`node`	`TIn`
`ctx`	`TCtx`
`isRoot`	`boolean`

Returns

Promise<Omit<TOut, "include">>

Functions

flattenTreeOptions()

function flattenTreeOptions<T>(items): Map<string, string>;

Defined in: tree/index.ts:322

Type Parameters

Type Parameter
`T` extends `object`

Parameters

Parameter	Type
`items`	`TreeOptionItem` & `object`[] \| `undefined`

Returns

Map<string, string>

renderTreeAscii()

function renderTreeAscii<T, K>(
   nodes, 
   childrenKey, 
   formatter): string;

Defined in: tree/index.ts:284

Type Parameters

Type Parameter
`T` extends `object`
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`nodes`	`T` \| readonly `T`[] \| `null` \| `undefined`
`childrenKey`	`K`
`formatter`	(`node`, `depth`) => `string`

Returns

string

toAsciiTree()

function toAsciiTree(
   root, 
   section, 
   items): string;

Defined in: tree/index.ts:272

Parameters

Parameter	Type
`root`	`string`
`section`	`string`
`items`	`string`[]

Returns

string

treeBuildIndex()

function treeBuildIndex<T, K, V>(
   nodes, 
   childrenKey, 
indexer): Record<string, V>;

Defined in: tree/index.ts:196

Type Parameters

Type Parameter
`T` extends `object`
`K` extends `string` \| `number` \| `symbol`
`V`

Parameters

Parameter	Type
`nodes`	readonly `T`[] \| `null` \| `undefined`
`childrenKey`	`K`
`indexer`	(`node`) => [`string`, `V`] \| [`string`, `V`][] \| `null`

Returns

Record<string, V>

treeFilterLeaves()

function treeFilterLeaves<T, K>(
   nodes, 
   childrenKey, 
   predicate): T[];

Defined in: tree/index.ts:39

Type Parameters

Type Parameter
`T` extends `object`
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`nodes`	readonly `T`[] \| `null` \| `undefined`
`childrenKey`	`K`
`predicate`	(`node`) => `boolean`

Returns

T[]

treeFind()

function treeFind<T, K>(
   nodes, 
   childrenKey, 
   predicate): T | null;

Defined in: tree/index.ts:22

Type Parameters

Type Parameter
`T` extends `object`
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`nodes`	readonly `T`[] \| `null` \| `undefined`
`childrenKey`	`K`
`predicate`	(`node`) => `boolean`

Returns

T | null

treeFlatten()

function treeFlatten<T, K>(nodes, childrenKey): T[];

Defined in: tree/index.ts:6

Type Parameters

Type Parameter
`T` extends `object`
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`nodes`	readonly `T`[] \| `null` \| `undefined`
`childrenKey`	`K`

Returns

T[]

treeInsert()

function treeInsert<T, K>(
   nodes, 
   childrenKey, 
   newNode, 
   parentId): T[];

Defined in: tree/index.ts:151

Type Parameters

Type Parameter
`T` extends `object` & `object`
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`nodes`	readonly `T`[] \| `null` \| `undefined`
`childrenKey`	`K`
`newNode`	`T`
`parentId`	`string` \| `null`

Returns

T[]

treeMap()

function treeMap<T, K>(
   nodes, 
   childrenKey, 
   mapper): T[];

Defined in: tree/index.ts:51

Type Parameters

Type Parameter
`T` extends `object`
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`nodes`	readonly `T`[] \| `null` \| `undefined`
`childrenKey`	`K`
`mapper`	(`node`) => `T`

Returns

T[]

treeMapRecordAsync()

function treeMapRecordAsync<TIn, TOut, TCtx>(
   node, 
   childrenKey, 
   config, 
   ctx, 
isRoot?): Promise<TOut>;

Defined in: tree/index.ts:227

Type Parameters

Type Parameter
`TIn` extends `object`
`TOut` extends `object`
`TCtx`

Parameters

Parameter	Type	Default value
`node`	`TIn`	`undefined`
`childrenKey`	keyof `TIn` & keyof `TOut` & `string`	`undefined`
`config`	`TreeMapRecordAsyncConfig`<`TIn`, `TOut`, `TCtx`>	`undefined`
`ctx`	`TCtx`	`undefined`
`isRoot`	`boolean`	`true`

Returns

Promise<TOut>

treeReduce()

function treeReduce<T, K, A>(
   root, 
   childrenKey, 
   reducer, 
   initial): A;

Defined in: tree/index.ts:87

Type Parameters

Type Parameter
`T` extends `object`
`K` extends `string` \| `number` \| `symbol`
`A`

Parameters

Parameter	Type
`root`	`T` \| readonly `T`[] \| `null` \| `undefined`
`childrenKey`	`K`
`reducer`	(`accumulator`, `node`, `parent`, `depth`) => `A`
`initial`	`A`

Returns

A

treeRemove()

function treeRemove<T, K>(
   nodes, 
   childrenKey, 
   predicate): object;

Defined in: tree/index.ts:117

Type Parameters

Type Parameter
`T` extends `object`
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`nodes`	readonly `T`[] \| `null` \| `undefined`
`childrenKey`	`K`
`predicate`	(`node`) => `boolean`

Returns

object

removed

removed: T | null;

result

result: T[];

treeUpdate()

function treeUpdate<T, K>(
   nodes, 
   childrenKey, 
   id, 
   updater): T[];

Defined in: tree/index.ts:176

Type Parameters

Type Parameter
`T` extends `object` & `object`
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`nodes`	readonly `T`[] \| `null` \| `undefined`
`childrenKey`	`K`
`id`	`string`
`updater`	(`node`) => `T`

Returns

T[]

treeWalk()

function treeWalk<T, K>(
   nodes, 
   childrenKey, 
   visitor, 
   parent?): void;

Defined in: tree/index.ts:70

Type Parameters

Type Parameter
`T` extends `object`
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type	Default value
`nodes`	readonly `T`[] \| `null` \| `undefined`	`undefined`
`childrenKey`	`K`	`undefined`
`visitor`	(`node`, `parent`) => `boolean` \| `void`	`undefined`
`parent`	`T` \| `null`	`null`

Returns

void