Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Vue

Hierarchy

  • default
    • Vue

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Vue(options?: ThisTypedComponentOptionsWithArrayProps<Vue, object, object, object, never>): Vue
  • new Vue(options?: ThisTypedComponentOptionsWithRecordProps<Vue, object, object, object, object>): Vue
  • new Vue(options?: ComponentOptions<Vue, DefaultData<Vue>, DefaultMethods<Vue>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps>): Vue

  • Parameters

    • Optional options: ThisTypedComponentOptionsWithArrayProps<Vue, object, object, object, never>

    Returns Vue

  • Parameters

    • Optional options: ThisTypedComponentOptionsWithRecordProps<Vue, object, object, object, object>

    Returns Vue

  • Parameters

    • Optional options: ComponentOptions<Vue, DefaultData<Vue>, DefaultMethods<Vue>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps>

    Returns Vue

Properties

Readonly $attrs

$attrs: Record<string, string>

Readonly $children

$children: Vue[]

$createElement

$createElement: CreateElement

Readonly $data

$data: Record<string, any>

$delete

$delete: { (object: object, key: string | number): void; <T>(array: T[], key: number): void }

Type declaration

    • (object: object, key: string | number): void
    • <T>(array: T[], key: number): void

    • Parameters

      • object: object
      • key: string | number

      Returns void

    • Type parameters

      • T

      Parameters

      • array: T[]
      • key: number

      Returns void

Readonly $el

$el: Element

Readonly $isServer

$isServer: boolean

Readonly $listeners

$listeners: Record<string, Function | Function[]>

Readonly $options

$options: ComponentOptions<Vue, DefaultData<Vue>, DefaultMethods<Vue>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps>

Readonly $parent

$parent: Vue

Readonly $props

$props: Record<string, any>

Readonly $refs

$refs: {}

Type declaration

  • [key: string]: Vue | Element | (Vue | Element)[] | undefined

Readonly $root

$root: Vue

$route

$route: Route

$router

$router: VueRouter

Readonly $scopedSlots

$scopedSlots: {}

Type declaration

  • [key: string]: NormalizedScopedSlot | undefined

$set

$set: { <T>(object: object, key: string | number, value: T): T; <T>(array: T[], key: number, value: T): T }

Type declaration

    • <T>(object: object, key: string | number, value: T): T
    • <T>(array: T[], key: number, value: T): T

    • Type parameters

      • T

      Parameters

      • object: object
      • key: string | number
      • value: T

      Returns T

    • Type parameters

      • T

      Parameters

      • array: T[]
      • key: number
      • value: T

      Returns T

Readonly $slots

$slots: {}

Type declaration

  • [key: string]: VNode[] | undefined

Readonly $ssrContext

$ssrContext: any

Readonly $vnode

$vnode: VNode

Static config

config: VueConfiguration

Static util

util: { warn: any }

Type declaration

  • warn:function
    • warn(msg: string, vm?: CombinedVueInstance<Vue, object, object, object, Record<never, any>>): void

    • Parameters

      • msg: string
      • Optional vm: CombinedVueInstance<Vue, object, object, object, Record<never, any>>

      Returns void

Static version

version: string

Methods

$destroy

  • $destroy(): void

  • Returns void

$emit

  • $emit(event: string, ...args: any[]): Vue

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns Vue

$forceUpdate

  • $forceUpdate(): void

  • Returns void

$mount

  • $mount(elementOrSelector?: string | Element, hydrating?: boolean): Vue

  • Parameters

    • Optional elementOrSelector: string | Element
    • Optional hydrating: boolean

    Returns Vue

$nextTick

  • $nextTick(callback: () => void): void
  • $nextTick(): Promise<void>

  • Parameters

    • callback: () => void
        • (): void

        • Returns void

    Returns void

  • Returns Promise<void>

$off

  • $off(event?: string | string[], callback?: Function): Vue

  • Parameters

    • Optional event: string | string[]
    • Optional callback: Function

    Returns Vue

$on

  • $on(event: string | string[], callback: Function): Vue

  • Parameters

    • event: string | string[]
    • callback: Function

    Returns Vue

$once

  • $once(event: string | string[], callback: Function): Vue

  • Parameters

    • event: string | string[]
    • callback: Function

    Returns Vue

$watch

  • $watch(expOrFn: string, callback: (n: any, o: any) => void, options?: WatchOptions): () => void
  • $watch<T>(expOrFn: () => T, callback: (n: T, o: T) => void, options?: WatchOptions): () => void

  • Parameters

    • expOrFn: string
    • callback: (n: any, o: any) => void
        • (n: any, o: any): void

        • Parameters

          • n: any
          • o: any

          Returns void

    • Optional options: WatchOptions

    Returns () => void

      • (): void

      • Returns void

  • Type parameters

    • T

    Parameters

    • expOrFn: () => T
        • (): T

        • Returns T

    • callback: (n: T, o: T) => void
        • (n: T, o: T): void

        • Parameters

          • n: T
          • o: T

          Returns void

    • Optional options: WatchOptions

    Returns () => void

      • (): void

      • Returns void

Optional activated

  • activated(): void

  • Returns void

Optional beforeCreate

  • beforeCreate(): void

  • Returns void

Optional beforeDestroy

  • beforeDestroy(): void

  • Returns void

Optional beforeMount

  • beforeMount(): void

  • Returns void

Optional beforeUpdate

  • beforeUpdate(): void

  • Returns void

Optional created

  • created(): void

  • Returns void

Optional data

  • data(): object

  • Returns object

Optional deactivated

  • deactivated(): void

  • Returns void

Optional destroyed

  • destroyed(): void

  • Returns void

Optional errorCaptured

  • errorCaptured(err: Error, vm: Vue, info: string): undefined | boolean

  • Parameters

    • err: Error
    • vm: Vue
    • info: string

    Returns undefined | boolean

Optional mounted

  • mounted(): void

  • Returns void

Optional render

  • render(createElement: CreateElement): VNode

  • Parameters

    • createElement: CreateElement

    Returns VNode

Optional serverPrefetch

  • serverPrefetch(): Promise<unknown>

  • Returns Promise<unknown>

Optional updated

  • updated(): void

  • Returns void

Static compile

  • compile(template: string): { staticRenderFns: (() => VNode)[]; render: any }

  • Parameters

    • template: string

    Returns { staticRenderFns: (() => VNode)[]; render: any }

    • staticRenderFns: (() => VNode)[]
    • render:function
      • render(createElement: any): VNode

      • Parameters

        • createElement: any

        Returns VNode

Static component

  • component(id: string): VueConstructor<Vue>
  • component<VC>(id: string, constructor: VC): VC
  • component<Data, Methods, Computed, Props>(id: string, definition: AsyncComponent<Data, Methods, Computed, Props>): ExtendedVue<Vue, Data, Methods, Computed, Props>
  • component<Data, Methods, Computed, PropNames>(id: string, definition?: ThisTypedComponentOptionsWithArrayProps<Vue, Data, Methods, Computed, PropNames>): ExtendedVue<Vue, Data, Methods, Computed, Record<PropNames, any>>
  • component<Data, Methods, Computed, Props>(id: string, definition?: ThisTypedComponentOptionsWithRecordProps<Vue, Data, Methods, Computed, Props>): ExtendedVue<Vue, Data, Methods, Computed, Props>
  • component<PropNames>(id: string, definition: FunctionalComponentOptions<Record<PropNames, any>, PropNames[]>): ExtendedVue<Vue, {}, {}, {}, Record<PropNames, any>>
  • component<Props>(id: string, definition: FunctionalComponentOptions<Props, RecordPropsDefinition<Props>>): ExtendedVue<Vue, {}, {}, {}, Props>
  • component(id: string, definition?: ComponentOptions<Vue, DefaultData<Vue>, DefaultMethods<Vue>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps>): ExtendedVue<Vue, {}, {}, {}, {}>

  • Parameters

    • id: string

    Returns VueConstructor<Vue>

  • Type parameters

    • VC: VueConstructor<Vue, VC>

    Parameters

    • id: string
    • constructor: VC

    Returns VC

  • Type parameters

    • Data

    • Methods

    • Computed

    • Props

    Parameters

    • id: string
    • definition: AsyncComponent<Data, Methods, Computed, Props>

    Returns ExtendedVue<Vue, Data, Methods, Computed, Props>

  • Type parameters

    • Data

    • Methods

    • Computed

    • PropNames: string = never

    Parameters

    • id: string
    • Optional definition: ThisTypedComponentOptionsWithArrayProps<Vue, Data, Methods, Computed, PropNames>

    Returns ExtendedVue<Vue, Data, Methods, Computed, Record<PropNames, any>>

  • Type parameters

    • Data

    • Methods

    • Computed

    • Props

    Parameters

    • id: string
    • Optional definition: ThisTypedComponentOptionsWithRecordProps<Vue, Data, Methods, Computed, Props>

    Returns ExtendedVue<Vue, Data, Methods, Computed, Props>

  • Type parameters

    • PropNames: string

    Parameters

    • id: string
    • definition: FunctionalComponentOptions<Record<PropNames, any>, PropNames[]>

    Returns ExtendedVue<Vue, {}, {}, {}, Record<PropNames, any>>

  • Type parameters

    • Props

    Parameters

    • id: string
    • definition: FunctionalComponentOptions<Props, RecordPropsDefinition<Props>>

    Returns ExtendedVue<Vue, {}, {}, {}, Props>

  • Parameters

    • id: string
    • Optional definition: ComponentOptions<Vue, DefaultData<Vue>, DefaultMethods<Vue>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps>

    Returns ExtendedVue<Vue, {}, {}, {}, {}>

Static delete

  • delete(object: object, key: string | number): void
  • delete<T>(array: T[], key: number): void

  • Parameters

    • object: object
    • key: string | number

    Returns void

  • Type parameters

    • T

    Parameters

    • array: T[]
    • key: number

    Returns void

Static directive

  • directive(id: string, definition?: DirectiveOptions | DirectiveFunction): DirectiveOptions

  • Parameters

    • id: string
    • Optional definition: DirectiveOptions | DirectiveFunction

    Returns DirectiveOptions

Static extend

  • extend<Data, Methods, Computed, PropNames>(options?: ThisTypedComponentOptionsWithArrayProps<Vue, Data, Methods, Computed, PropNames>): ExtendedVue<Vue, Data, Methods, Computed, Record<PropNames, any>>
  • extend<Data, Methods, Computed, Props>(options?: ThisTypedComponentOptionsWithRecordProps<Vue, Data, Methods, Computed, Props>): ExtendedVue<Vue, Data, Methods, Computed, Props>
  • extend<PropNames>(definition: FunctionalComponentOptions<Record<PropNames, any>, PropNames[]>): ExtendedVue<Vue, {}, {}, {}, Record<PropNames, any>>
  • extend<Props>(definition: FunctionalComponentOptions<Props, RecordPropsDefinition<Props>>): ExtendedVue<Vue, {}, {}, {}, Props>
  • extend(options?: ComponentOptions<Vue, DefaultData<Vue>, DefaultMethods<Vue>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps>): ExtendedVue<Vue, {}, {}, {}, {}>

  • Type parameters

    • Data

    • Methods

    • Computed

    • PropNames: string = never

    Parameters

    • Optional options: ThisTypedComponentOptionsWithArrayProps<Vue, Data, Methods, Computed, PropNames>

    Returns ExtendedVue<Vue, Data, Methods, Computed, Record<PropNames, any>>

  • Type parameters

    • Data

    • Methods

    • Computed

    • Props

    Parameters

    • Optional options: ThisTypedComponentOptionsWithRecordProps<Vue, Data, Methods, Computed, Props>

    Returns ExtendedVue<Vue, Data, Methods, Computed, Props>

  • Type parameters

    • PropNames: string = never

    Parameters

    • definition: FunctionalComponentOptions<Record<PropNames, any>, PropNames[]>

    Returns ExtendedVue<Vue, {}, {}, {}, Record<PropNames, any>>

  • Type parameters

    • Props

    Parameters

    • definition: FunctionalComponentOptions<Props, RecordPropsDefinition<Props>>

    Returns ExtendedVue<Vue, {}, {}, {}, Props>

  • Parameters

    • Optional options: ComponentOptions<Vue, DefaultData<Vue>, DefaultMethods<Vue>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps>

    Returns ExtendedVue<Vue, {}, {}, {}, {}>

Static filter

  • filter(id: string, definition?: Function): Function

  • Parameters

    • id: string
    • Optional definition: Function

    Returns Function

Static mixin

  • mixin(mixin: VueConstructor<Vue> | ComponentOptions<Vue, DefaultData<Vue>, DefaultMethods<Vue>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps>): VueConstructor<Vue>

  • Parameters

    • mixin: VueConstructor<Vue> | ComponentOptions<Vue, DefaultData<Vue>, DefaultMethods<Vue>, DefaultComputed, PropsDefinition<DefaultProps>, DefaultProps>

    Returns VueConstructor<Vue>

Static nextTick

  • nextTick<T>(callback: () => void, context?: T): void
  • nextTick(): Promise<void>

  • Type parameters

    • T

    Parameters

    • callback: () => void
        • (): void

        • Returns void

    • Optional context: T

    Returns void

  • Returns Promise<void>

Static observable

  • observable<T>(obj: T): T

  • Type parameters

    • T

    Parameters

    • obj: T

    Returns T

Static set

  • set<T>(object: object, key: string | number, value: T): T
  • set<T>(array: T[], key: number, value: T): T

  • Type parameters

    • T

    Parameters

    • object: object
    • key: string | number
    • value: T

    Returns T

  • Type parameters

    • T

    Parameters

    • array: T[]
    • key: number
    • value: T

    Returns T

Static use

  • use<T>(plugin: PluginObject<T> | PluginFunction<T>, options?: T): VueConstructor<Vue>
  • use(plugin: PluginObject<any> | PluginFunction<any>, ...options: any[]): VueConstructor<Vue>

  • Type parameters

    • T

    Parameters

    • plugin: PluginObject<T> | PluginFunction<T>
    • Optional options: T

    Returns VueConstructor<Vue>

  • Parameters

    • plugin: PluginObject<any> | PluginFunction<any>
    • Rest ...options: any[]

    Returns VueConstructor<Vue>

Generated using TypeDoc