Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TraitModel<R, S, U>

Type parameters

Hierarchy

  • TraitModel

Callable

  • TraitModel(): null | S
  • TraitModel(model: null | S | U, targetModel?: null | Model): R

  • Returns null | S

  • Parameters

    • model: null | S | U
    • Optional targetModel: null | Model

    Returns R

Index

Properties

Methods

Properties

Optional child

child: boolean

fastenerFlags

fastenerFlags: number

Readonly key

key: undefined | string

Readonly model

model: null | S

Readonly name

name: string

Optional observe

observe: boolean

Readonly owner

owner: R

Readonly parentModel

parentModel: null | Model

Optional Readonly type

type: unknown

Methods

attachModel

  • attachModel(newModel: S): void

  • Parameters

    • newModel: S

    Returns void

createModel

  • createModel(): null | S | U

  • Returns null | S | U

detachModel

  • detachModel(oldModel: S): void

  • Parameters

    • oldModel: S

    Returns void

didMount

  • didMount(): void

  • Returns void

didSetModel

  • didSetModel(newModel: null | S, oldModel: null | S, targetModel: null | Model): void

  • Parameters

    • newModel: null | S
    • oldModel: null | S
    • targetModel: null | Model

    Returns void

didUnmount

  • didUnmount(): void

  • Returns void

doSetModel

  • doSetModel(newModel: null | S, targetModel: null | Model): void

  • Parameters

    • newModel: null | S
    • targetModel: null | Model

    Returns void

fromAny

  • fromAny(value: S | U): null | S

  • Parameters

    • value: S | U

    Returns null | S

getModel

  • getModel(): S

  • Returns S

injectModel

  • injectModel(parentModel?: null | Model, childModel?: null | S | U, targetModel?: null | Model, key?: null | string): null | S

  • Parameters

    • Optional parentModel: null | Model
    • Optional childModel: null | S | U
    • Optional targetModel: null | Model
    • Optional key: null | string

    Returns null | S

insertModel

  • insertModel(parentModel: Model, childModel: S, targetModel: null | Model, key: undefined | string): void

  • Parameters

    • parentModel: Model
    • childModel: S
    • targetModel: null | Model
    • key: undefined | string

    Returns void

isMounted

  • isMounted(): boolean

  • Returns boolean

mount

  • mount(): void

  • Returns void

onMount

  • onMount(): void

  • Returns void

onSetModel

  • onSetModel(newModel: null | S, oldModel: null | S, targetModel: null | Model): void

  • Parameters

    • newModel: null | S
    • oldModel: null | S
    • targetModel: null | Model

    Returns void

onUnmount

  • onUnmount(): void

  • Returns void

removeModel

  • removeModel(): null | S

  • Returns null | S

setFastenerFlags

  • setFastenerFlags(fastenerFlags: number): void

  • Parameters

    • fastenerFlags: number

    Returns void

setModel

  • setModel(newModel: null | S | U, targetModel?: null | Model): null | S

  • Parameters

    • newModel: null | S | U
    • Optional targetModel: null | Model

    Returns null | S

unmount

  • unmount(): void

  • Returns void

willMount

  • willMount(): void

  • Returns void

willSetModel

  • willSetModel(newModel: null | S, oldModel: null | S, targetModel: null | Model): void

  • Parameters

    • newModel: null | S
    • oldModel: null | S
    • targetModel: null | Model

    Returns void

willUnmount

  • willUnmount(): void

  • Returns void

Generated using TypeDoc