Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GenericHierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly childMap

childMap: null | Dictionary<Hierarchy>

Readonly children

children: readonly Hierarchy[]

Readonly decoherent

decoherent: null | readonly Fastener<unknown>[]

Optional Readonly familyType

familyType: Class<Hierarchy>

Readonly fasteners

fasteners: null | {}

Readonly flags

flags: number

Readonly key

key: undefined | string

Optional Readonly observerType

observerType: Class<HierarchyObserver<Hierarchy>>

Readonly observers

observers: readonly HierarchyObserver<Hierarchy>[]

Readonly parent

parent: null | Hierarchy

Readonly uid

uid: number

Static Readonly FlagMask

FlagMask: number

Static Readonly FlagShift

FlagShift: number

Static Readonly InsertChildFlags

InsertChildFlags: number

Static Readonly MountFlags

MountFlags: number

Static Readonly MountedFlag

MountedFlag: number

Static Readonly RemoveChildFlags

RemoveChildFlags: number

Static Readonly RemovingFlag

RemovingFlag: number

Static Readonly TraversingFlag

TraversingFlag: number

Static uid

uid: () => number

Type declaration

    • (): number

    • Returns number

Accessors

childCount

  • get childCount(): number

  • Returns number

insertChildFlags

  • get insertChildFlags(): number

  • Returns number

mountFlags

  • get mountFlags(): number

  • Returns number

mounted

  • get mounted(): boolean

  • Returns boolean

removeChildFlags

  • get removeChildFlags(): number

  • Returns number

traversing

  • get traversing(): boolean

  • Returns boolean

Methods

appendChild

  • appendChild<H>(child: H, key?: string): H

  • Type parameters

    Parameters

    • child: H
    • Optional key: string

    Returns H

Protected attachFastener

  • attachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

attachParent

  • Parameters

    Returns void

callObservers

  • Type parameters

    • O

    • K: string | number | symbol

    Parameters

    Returns void

cascadeInsert

  • cascadeInsert(): void

  • Returns void

cascadeMount

  • cascadeMount(): void

  • Returns void

cascadeUnmount

  • cascadeUnmount(): void

  • Returns void

decohereFastener

  • decohereFastener(fastener: Fastener<unknown>): void

  • Parameters

    Returns void

Protected detachFastener

  • detachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

detachParent

  • Parameters

    Returns void

Protected didAttachFastener

  • didAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected didAttachParent

  • Parameters

    Returns void

Protected didDetachFastener

  • didDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected didDetachParent

  • Parameters

    Returns void

Protected didInsertChild

Protected didMount

  • didMount(): void

  • Returns void

Protected didObserve

Protected didRemoveChild

  • Parameters

    Returns void

Protected didUnmount

  • didUnmount(): void

  • Returns void

Protected didUnobserve

equals

  • equals(that: unknown): boolean

  • Parameters

    • that: unknown

    Returns boolean

firstChild

  • Returns null | Hierarchy

forEachChild

  • forEachChild<T>(callback: (child: Hierarchy) => void | T): undefined | T
  • forEachChild<T, S>(callback: (child: Hierarchy) => void | T, thisArg: S): undefined | T

  • Type parameters

    • T

    Parameters

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

    Returns undefined | T

forEachObserver

getBase

  • getBase<F>(baseBound: F): null | InstanceType<F>

  • Type parameters

    Parameters

    • baseBound: F

    Returns null | InstanceType<F>

getChild

  • getChild<F>(key: string, childBound: F): null | InstanceType<F>
  • getChild(key: string, childBound?: new (...args: any[]) => Hierarchy): null | Hierarchy

  • Type parameters

    Parameters

    • key: string
    • childBound: F

    Returns null | InstanceType<F>

  • Parameters

    • key: string
    • Optional childBound: new (...args: any[]) => Hierarchy

    Returns null | Hierarchy

getFastener

  • getFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>

  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

getLazyFastener

  • getLazyFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getLazyFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>

  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

getSuper

  • getSuper<F>(superBound: F): null | InstanceType<F>

  • Type parameters

    Parameters

    • superBound: F

    Returns null | InstanceType<F>

getSuperFastener

  • getSuperFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getSuperFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>

  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

hasFastener

  • hasFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): boolean

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns boolean

hashCode

  • hashCode(): number

  • Returns number

insertChild

  • insertChild<H>(child: H, target: null | Hierarchy, key?: string): H

  • Type parameters

    Parameters

    • child: H
    • target: null | Hierarchy
    • Optional key: string

    Returns H

Protected insertChildMap

  • Parameters

    Returns void

lastChild

  • Returns null | Hierarchy

mount

  • mount(): void

  • Returns void

Protected mountChildren

  • mountChildren(): void

  • Returns void

Protected mountFasteners

  • mountFasteners(): void

  • Returns void

nextChild

  • Parameters

    Returns null | Hierarchy

observe

Protected onAttachFastener

  • onAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected onAttachParent

  • Parameters

    Returns void

Protected onDetachFastener

  • onDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected onDetachParent

  • Parameters

    Returns void

Protected onInsertChild

Protected onMount

  • onMount(): void

  • Returns void

Protected onObserve

Protected onRemoveChild

  • Parameters

    Returns void

Protected onUnmount

  • onUnmount(): void

  • Returns void

Protected onUnobserve

prependChild

  • prependChild<H>(child: H, key?: string): H

  • Type parameters

    Parameters

    • child: H
    • Optional key: string

    Returns H

previousChild

recohereFasteners

  • recohereFasteners(t?: number): void

  • Parameters

    • Optional t: number

    Returns void

remove

  • remove(): void

  • Returns void

removeChild

  • removeChild(key: string): null | Hierarchy
  • removeChild<H>(child: H): H

  • Parameters

    • key: string

    Returns null | Hierarchy

  • Type parameters

    Parameters

    • child: H

    Returns H

Protected removeChildMap

  • Parameters

    Returns void

removeChildren

  • removeChildren(): void

  • Returns void

replaceChild

  • replaceChild<H>(newChild: Hierarchy, oldChild: H): H

  • Type parameters

    Parameters

    Returns H

Protected replaceChildMap

  • Parameters

    Returns void

requireUpdate

  • requireUpdate(updateFlags: number, immediate?: boolean): void

  • Parameters

    • updateFlags: number
    • Optional immediate: boolean

    Returns void

setChild

  • Parameters

    Returns null | Hierarchy

setFastener

  • setFastener(fastenerName: string, newFastener: null | Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • newFastener: null | Fastener<unknown>

    Returns void

setFlags

  • setFlags(flags: number): void

  • Parameters

    • flags: number

    Returns void

setKey

  • setKey(key: undefined | string): void

  • Parameters

    • key: undefined | string

    Returns void

unmount

  • unmount(): void

  • Returns void

Protected unmountChildren

  • unmountChildren(): void

  • Returns void

Protected unmountFasteners

  • unmountFasteners(): void

  • Returns void

unobserve

Protected willAttachFastener

  • willAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected willAttachParent

  • Parameters

    Returns void

Protected willDetachFastener

  • willDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected willDetachParent

  • Parameters

    Returns void

Protected willInsertChild

Protected willMount

  • willMount(): void

  • Returns void

Protected willObserve

Protected willRemoveChild

  • Parameters

    Returns void

Protected willUnmount

  • willUnmount(): void

  • Returns void

Protected willUnobserve

Generated using TypeDoc