Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BooleanModelProperty<M>

Type parameters

Hierarchy

  • ModelProperty<M, boolean | null | undefined, boolean | string | null | undefined>
    • BooleanModelProperty

Callable

  • BooleanModelProperty(): undefined | null | boolean
  • BooleanModelProperty(state: undefined | null | string | boolean, precedence?: number): M
  • Returns undefined | null | boolean

  • Parameters

    • state: undefined | null | string | boolean
    • Optional precedence: number

    Returns M

Index

Constructors

constructor

  • Type parameters

    Parameters

    • owner: M
    • propertyName: undefined | string

    Returns BooleanModelProperty<M>

Properties

Readonly inherit

inherit: string | boolean

Readonly name

name: string

Readonly ownState

ownState: undefined | null | boolean

Readonly owner

owner: M

Readonly precedence

precedence: number

propertyFlags

propertyFlags: number

Readonly state

state: undefined | null | boolean

Readonly subProperties

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

Readonly superName

superName: undefined | string

Readonly superProperty

superProperty: null | ModelProperty<Model, undefined | null | boolean, never>

Readonly superState

superState: undefined | null | boolean

Optional updateFlags

updateFlags: number

Readonly updatedState

updatedState: undefined | null | boolean

Static InheritedFlag

InheritedFlag: number

Static MountedFlag

MountedFlag: number

Static OverrideFlag

OverrideFlag: number

Static UpdatedFlag

UpdatedFlag: number

Methods

addSubProperty

  • addSubProperty(subProperty: ModelProperty<Model, undefined | null | boolean, never>): void
  • 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: undefined | null | boolean, oldState: undefined | null | boolean): void
  • Parameters

    • newState: undefined | null | boolean
    • oldState: undefined | null | boolean

    Returns void

didUnmount

  • didUnmount(): void
  • Returns void

equalState

  • equalState(newState: undefined | null | boolean, oldState: undefined | null | boolean): boolean
  • Parameters

    • newState: undefined | null | boolean
    • oldState: undefined | null | boolean

    Returns boolean

fromAny

  • fromAny(value: undefined | null | string | boolean): undefined | null | boolean
  • Parameters

    • value: undefined | null | string | boolean

    Returns undefined | null | boolean

getState

  • getState(): boolean
  • Returns boolean

getStateOr

  • getStateOr<E>(elseState: E): boolean | E
  • Type parameters

    • E

    Parameters

    • elseState: E

    Returns boolean | 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: undefined | null | boolean, oldState: undefined | null | boolean): void
  • Parameters

    • newState: undefined | null | boolean
    • oldState: undefined | null | boolean

    Returns void

onUnmount

  • onUnmount(): void
  • Returns void

removeSubProperty

  • removeSubProperty(subProperty: ModelProperty<Model, undefined | null | boolean, never>): void
  • 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: undefined | null | string | boolean): void
  • Parameters

    • state: undefined | null | string | boolean

    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: undefined | null | string | boolean, precedence?: number): void
  • Parameters

    • state: undefined | null | string | boolean
    • Optional precedence: number

    Returns void

takeState

  • takeState(): undefined | null | boolean
  • Returns undefined | null | boolean

takeUpdatedState

  • takeUpdatedState(): undefined | null | boolean
  • Returns undefined | null | boolean

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: undefined | null | boolean, oldState: undefined | null | boolean): void
  • Parameters

    • newState: undefined | null | boolean
    • oldState: undefined | null | boolean

    Returns void

willMount

  • willMount(): void
  • Returns void

willSetPrecedence

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

    • newPrecedence: number
    • oldPrecedence: number

    Returns void

willSetState

  • willSetState(newState: undefined | null | boolean, oldState: undefined | null | boolean): void
  • Parameters

    • newState: undefined | null | boolean
    • oldState: undefined | null | boolean

    Returns void

willUnmount

  • willUnmount(): void
  • Returns void

Static define

  • Type parameters

    • M_7: Model<M_7>

    • T_7

    • U_7 = never

    • I_1 = {}

    Parameters

    Returns ModelPropertyConstructor<M_7, T_7, U_7, I_1>

  • Type parameters

    • M_8: Model<M_8>

    • T_8

    • U_8 = never

    Parameters

    Returns ModelPropertyConstructor<M_8, T_8, U_8, {}>

Static getClass

  • Parameters

    • type: unknown

    Returns null | ModelPropertyClass

Generated using TypeDoc