aspen-core
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Accessors

branchSize

branchSize:

Number of visible flattened leaves this branch is incharge of (recursive)

When a directory is expanded, its entire branch (recursively flattened) is owned by a branch higher up (either Root (at surface) or a branch in collapsed state (buried))

When a directory is collapsed, its entire branch (recursively flattened) is "returned" back to it by one of its parent higher up

children

children:

expanded

expanded:

type

type:

Methods

ensureLoaded

  • ensureLoaded(): Promise<void>
  • Ensures the children of this Directory are loaded (without effecting the expanded state)

    If children are already loaded, returned Promise resolves immediately

    Otherwise a hard reload request is issued and returned Promise resolves when that process finishes.

    tl;dr: Directory#children are accessible once the returned Promise resolves

    Returns Promise<void>

insertItem

  • Inserts the item into it's own parent (if not already)

    Gets called upon IWatcherAddEvent or IWatcherMoveEvent

    Calling this method directly WILL NOT trigger onWillHandleWatchEvent and onDidHandleWatchEvent events

    Prefer using Root#inotify instead

    Parameters

    Returns void

mv

setCollapsed

  • setCollapsed(): void

setExpanded

  • setExpanded(ensureVisible?: boolean): Promise<void>
  • Parameters

    • Default value ensureVisible: boolean = true

    Returns Promise<void>

unlinkItem

  • Removes the item from parent

    Gets called upon IWatcherRemoveEvent or IWatcherMoveEvent

    Calling this method directly WILL NOT trigger onWillHandleWatchEvent and onDidHandleWatchEvent events

    Prefer using Root#inotify instead

    Parameters

    Returns void

Static defaultSortComparator

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc