Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ModelProperty<M, T, U>

Type parameters

Hierarchy

  • ModelProperty

Callable

  • ModelProperty(): T
  • ModelProperty(state: T | U, precedence?: number): M

  • Returns T

  • Parameters

    • state: T | U
    • Optional precedence: number

    Returns M

Index

Properties

Methods

Properties

Readonly inherit

inherit: string | boolean

Readonly name

name: string

Readonly ownState

ownState: T

Readonly owner

owner: M

Readonly precedence

precedence: number

propertyFlags

propertyFlags: number

Readonly state

state: T

Readonly subProperties

subProperties: null | ModelProperty<Model, T, never>[]

Readonly superName

superName: undefined | string

Readonly superProperty

superProperty: null | ModelProperty<Model, T, never>

Readonly superState

superState: undefined | T

Optional updateFlags

updateFlags: number

Readonly updatedState

updatedState: undefined | T

Methods

addSubProperty

  • Parameters

    Returns void

bindSuperProperty

  • bindSuperProperty(): void

  • Returns void

didMount

  • didMount(): void

  • Returns void

didSetPrecedence

  • didSetPrecedence(newPrecedence: number, oldPrecedence: number): void

  • Parameters

    • newPrecedence: number
    • oldPrecedence: number

    Returns void

didSetState

  • didSetState(newState: T, oldState: T): void

  • Parameters

    • newState: T
    • oldState: T

    Returns void

didUnmount

  • didUnmount(): void

  • Returns void

equalState

  • equalState(newState: T, oldState: T): boolean

  • Parameters

    • newState: T
    • oldState: T

    Returns boolean

fromAny

  • fromAny(value: T | U): T

  • Parameters

    • value: T | U

    Returns T

getState

  • getState(): NonNullable<T>

  • Returns NonNullable<T>

getStateOr

  • getStateOr<E>(elseState: E): NonNullable<T> | E

  • Type parameters

    • E

    Parameters

    • elseState: E

    Returns NonNullable<T> | E

isInherited

  • isInherited(): boolean

  • Returns boolean

isMounted

  • isMounted(): boolean

  • Returns boolean

isUpdated

  • isUpdated(): boolean

  • Returns boolean

mount

  • mount(): void

  • Returns void

mutate

  • mutate(): void

  • Returns void

onMount

  • onMount(): void

  • Returns void

onMutate

  • onMutate(): void

  • Returns void

onMutateInherited

  • onMutateInherited(): void

  • Returns void

onSetPrecedence

  • onSetPrecedence(newPrecedence: number, oldPrecedence: number): void

  • Parameters

    • newPrecedence: number
    • oldPrecedence: number

    Returns void

onSetState

  • onSetState(newState: T, oldState: T): void

  • Parameters

    • newState: T
    • oldState: T

    Returns void

onUnmount

  • onUnmount(): void

  • Returns void

removeSubProperty

  • Parameters

    Returns void

setInherit

  • setInherit(inherit: string | boolean): void

  • Parameters

    • inherit: string | boolean

    Returns void

setInherited

  • setInherited(inherited: boolean): void

  • Parameters

    • inherited: boolean

    Returns void

setOwnState

  • setOwnState(state: T | U): void

  • Parameters

    • state: T | U

    Returns void

setPrecedence

  • setPrecedence(precedence: number): void

  • Parameters

    • precedence: number

    Returns void

setPropertyFlags

  • setPropertyFlags(propertyFlags: number): void

  • Parameters

    • propertyFlags: number

    Returns void

setState

  • setState(state: T | U, precedence?: number): void

  • Parameters

    • state: T | U
    • Optional precedence: number

    Returns void

takeState

  • takeState(): T

  • Returns T

takeUpdatedState

  • takeUpdatedState(): undefined | T

  • Returns undefined | T

takesPrecedence

  • takesPrecedence(precedence: number): boolean

  • Parameters

    • precedence: number

    Returns boolean

toString

  • toString(): string

  • Returns string

unbindSuperProperty

  • unbindSuperProperty(): void

  • Returns void

unmount

  • unmount(): void

  • Returns void

updateSubProperties

  • updateSubProperties(newState: T, oldState: T): void

  • Parameters

    • newState: T
    • oldState: T

    Returns void

willMount

  • willMount(): void

  • Returns void

willSetPrecedence

  • willSetPrecedence(newPrecedence: number, oldPrecedence: number): void

  • Parameters

    • newPrecedence: number
    • oldPrecedence: number

    Returns void

willSetState

  • willSetState(newState: T, oldState: T): void

  • Parameters

    • newState: T
    • oldState: T

    Returns void

willUnmount

  • willUnmount(): void

  • Returns void

Generated using TypeDoc