Interface ComponentOptionsBase<Props, RawBindings, D, C, M, Mixin, Extends, E, EE, Defaults, I, II, S>

Interface for declaring custom options.

Example

declare module '@vue/runtime-core' {
  interface ComponentCustomOptions {
    beforeRouteUpdate?(
      to: Route,
      from: Route,
      next: () => void
    ): void
  }
}
interface ComponentOptionsBase<Props, RawBindings, D, C extends ComputedOptions, M extends MethodOptions, Mixin extends ComponentOptionsMixin, Extends extends ComponentOptionsMixin, E extends EmitsOptions, EE extends string, Defaults, I extends ComponentInjectOptions, II extends string, S extends SlotsType> {
    __defaults?: Defaults;
    __differentiator?: keyof D | keyof C | keyof M;
    __file?: string;
    __isBuiltIn?: boolean;
    __isFragment?: undefined;
    __isSuspense?: undefined;
    __isTeleport?: undefined;
    __name?: string;
    call?: ((this: unknown, ...args: unknown[]) => never);
    compatConfig?: CompatConfig;
    compilerOptions?: RuntimeCompilerOptions;
    components?: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>>;
    computed?: C;
    data?: ((this: CreateComponentPublicInstance<Props, {}, {}, {}, MethodOptions, Mixin, Extends, {}, Props, {}, false, {}, {}, IntersectionMixin<Mixin> & IntersectionMixin<Extends>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "P"> & EnsureNonVoid<Props>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "B"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "D"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "C"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "M"> & MethodOptions, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "Defaults"> & {}>, vm: CreateComponentPublicInstance<Props, {}, {}, {}, MethodOptions, Mixin, Extends, {}, Props, {}, false, {}, {}, IntersectionMixin<Mixin> & IntersectionMixin<Extends>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "P"> & EnsureNonVoid<Props>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "B"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "D"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "C"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "M"> & MethodOptions, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "Defaults"> & {}>) => D);
    delimiters?: [string, string];
    directives?: Record<string, Directive<any, any>>;
    emits?: (E | EE[]) & ThisType<void>;
    errorCaptured?: ErrorCapturedHook<unknown>;
    expose?: string[];
    extends?: Extends;
    filters?: Record<string, Function>;
    inheritAttrs?: boolean;
    inject?: I | II[];
    methods?: M;
    mixins?: Mixin[];
    name?: string;
    provide?: ComponentProvideOptions;
    render?: Function;
    renderTracked?: DebuggerHook;
    renderTriggered?: DebuggerHook;
    setup?: ((this: void, props: LooseRequired<Props & {
        [K in string | number | symbol]: UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "P">[K]
    }>, ctx: SetupContext<E, S>) => void | RawBindings | RenderFunction | Promise<RawBindings>);
    slots?: S;
    template?: string | object;
    watch?: ComponentWatchOptions;
    activated?(): void;
    beforeCreate?(): void;
    beforeDestroy?(): void;
    beforeMount?(): void;
    beforeUnmount?(): void;
    beforeUpdate?(): void;
    created?(): void;
    deactivated?(): void;
    destroyed?(): void;
    mounted?(): void;
    serverPrefetch?(): void | Promise<any>;
    unmounted?(): void;
    updated?(): void;
}

Type Parameters

Hierarchy-Diagram

UML class diagram of ComponentOptionsBase
Legend
icon for an interface in the UML class diagram interface
icon for a public property in the UML class diagram public property
icon for a public method in the UML class diagram public method

Hierarchy (view full)

Properties

__defaults? __differentiator? __file? __isBuiltIn? __isFragment? __isSuspense? __isTeleport? __name? call? compatConfig? compilerOptions? components? computed? data? delimiters? directives? emits? errorCaptured? expose? extends? filters? inheritAttrs? inject? methods? mixins? name? provide? render? renderTracked? renderTriggered? setup? slots? template? watch?

Methods

activated? beforeCreate? beforeDestroy? beforeMount? beforeUnmount? beforeUpdate? created? deactivated? destroyed? mounted? serverPrefetch? unmounted? updated?

Properties

Optional __defaults

__defaults?: Defaults

Optional __differentiator

__differentiator?: keyof D | keyof C | keyof M

#3468

type-only, used to assist Mixin's type inference, typescript will try to simplify the inferred Mixin type, with the __differentiator, typescript won't be able to combine different mixins, because the __differentiator will be different

Optional __file

__file?: string

This one should be exposed so that devtools can make use of it

Optional __isBuiltIn

__isBuiltIn?: boolean

Compat build only, for bailing out of certain compatibility behavior

Optional __isFragment

__isFragment?: undefined

Optional __isSuspense

__isSuspense?: undefined

Optional __isTeleport

__isTeleport?: undefined

Optional __name

__name?: string

name inferred from filename

Optional call

call?: ((this: unknown, ...args: unknown[]) => never)

Type declaration

    • (this: unknown, ...args: unknown[]): never

    • Parameters

      • this: unknown
      • Rest ...args: unknown[]

      Returns never

Optional compatConfig

compatConfig?: CompatConfig

Optional compilerOptions

compilerOptions?: RuntimeCompilerOptions

Optional components

components?: Record<string, Component<any, any, any, ComputedOptions, MethodOptions, {}, any>>

Optional computed

computed?: C

Optional data

data?: ((this: CreateComponentPublicInstance<Props, {}, {}, {}, MethodOptions, Mixin, Extends, {}, Props, {}, false, {}, {}, IntersectionMixin<Mixin> & IntersectionMixin<Extends>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "P"> & EnsureNonVoid<Props>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "B"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "D"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "C"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "M"> & MethodOptions, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "Defaults"> & {}>, vm: CreateComponentPublicInstance<Props, {}, {}, {}, MethodOptions, Mixin, Extends, {}, Props, {}, false, {}, {}, IntersectionMixin<Mixin> & IntersectionMixin<Extends>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "P"> & EnsureNonVoid<Props>, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "B"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "D"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "C"> & {}, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "M"> & MethodOptions, UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "Defaults"> & {}>) => D)

Type declaration

Optional delimiters

delimiters?: [string, string]

runtime compile only

Deprecated

use compilerOptions.delimiters instead.

Optional directives

directives?: Record<string, Directive<any, any>>

Optional emits

emits?: (E | EE[]) & ThisType<void>

Optional errorCaptured

errorCaptured?: ErrorCapturedHook<unknown>

Optional expose

expose?: string[]

Optional extends

extends?: Extends

Optional filters

filters?: Record<string, Function>

Optional inheritAttrs

inheritAttrs?: boolean

Optional inject

inject?: I | II[]

Optional methods

methods?: M

Optional mixins

mixins?: Mixin[]

Optional name

name?: string

Optional provide

provide?: ComponentProvideOptions

Optional render

render?: Function

Optional renderTracked

renderTracked?: DebuggerHook

Optional renderTriggered

renderTriggered?: DebuggerHook

Optional setup

setup?: ((this: void, props: LooseRequired<Props & {
    [K in string | number | symbol]: UnwrapMixinsType<IntersectionMixin<Mixin> & IntersectionMixin<Extends>, "P">[K]
}>, ctx: SetupContext<E, S>) => void | RawBindings | RenderFunction | Promise<RawBindings>)

Type declaration

Optional slots

slots?: S

Optional template

template?: string | object

Optional watch

watch?: ComponentWatchOptions

Methods

Optional activated

  • activated(): void

  • Returns void

Optional beforeCreate

  • beforeCreate(): void

  • Returns void

Optional beforeDestroy

  • beforeDestroy(): void

  • Returns void

    Deprecated

    use beforeUnmount instead

Optional beforeMount

  • beforeMount(): void

  • Returns void

Optional beforeUnmount

  • beforeUnmount(): void

  • Returns void

Optional beforeUpdate

  • beforeUpdate(): void

  • Returns void

Optional created

  • created(): void

  • Returns void

Optional deactivated

  • deactivated(): void

  • Returns void

Optional destroyed

  • destroyed(): void

  • Returns void

    Deprecated

    use unmounted instead

Optional mounted

  • mounted(): void

  • Returns void

Optional serverPrefetch

  • serverPrefetch(): void | Promise<any>

  • Returns void | Promise<any>

Optional unmounted

  • unmounted(): void

  • Returns void

Optional updated

  • updated(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

__defaults__differentiator__file__isBuiltIn__isFragment__isSuspense__isTeleport__namecallcompatConfigcompilerOptionscomponentscomputeddatadelimitersdirectivesemitserrorCapturedexposeextendsfiltersinheritAttrsinjectmethodsmixinsnameproviderenderrenderTrackedrenderTriggeredsetupslotstemplatewatchactivatedbeforeCreatebeforeDestroybeforeMountbeforeUnmountbeforeUpdatecreateddeactivateddestroyedmountedserverPrefetchunmountedupdated