Type Alias: ComponentPublicInstance<P, B, D, C, M, E, PublicProps, Defaults, MakeDefaultsOptional, Options, I, S, Exposed, TypeRefs, TypeEl>
ts
type ComponentPublicInstance<
P,
B,
D,
C,
M,
E,
PublicProps,
Defaults,
MakeDefaultsOptional,
Options,
I,
S,
Exposed,
TypeRefs,
TypeEl,
> = {
$: ComponentInternalInstance;
$attrs: Data;
$data: D;
$el: TypeEl;
$emit: EmitFn<E>;
$forceUpdate: () => void;
$host: Element | null;
$nextTick: typeof nextTick;
$options: Options & MergedComponentOptionsOverride;
$parent: ComponentPublicInstance | null;
$props: MakeDefaultsOptional extends true
? Partial<Defaults> & Omit<Prettify<P> & PublicProps, keyof Defaults>
: Prettify<P> & PublicProps;
$refs: Data & TypeRefs;
$root: ComponentPublicInstance | null;
$slots: UnwrapSlotsType<S>;
$watch: WatchStopHandle;
} & ExposedKeys<
IfAny<
P,
P,
Readonly<Defaults> & Omit<P, keyof ShallowUnwrapRef<B> | keyof Defaults>
> &
ShallowUnwrapRef<B> &
UnwrapNestedRefs<D> &
ExtractComputedReturns<C> &
M &
ComponentCustomProperties &
InjectToObject<I>,
Exposed
>;Type Declaration
| Name | Type |
|---|---|
$ | ComponentInternalInstance |
$attrs | Data |
$data | D |
$el | TypeEl |
$emit | EmitFn<E> |
$forceUpdate() | () => void |
$host | Element | null |
$nextTick | typeof nextTick |
$options | Options & MergedComponentOptionsOverride |
$parent | ComponentPublicInstance | null |
$props | MakeDefaultsOptional extends true ? Partial<Defaults> & Omit<Prettify<P> & PublicProps, keyof Defaults> : Prettify<P> & PublicProps |
$refs | Data & TypeRefs |
$root | ComponentPublicInstance | null |
$slots | UnwrapSlotsType<S> |
$watch() | ( source: T, cb: T extends (...args: any) => R ? (...args: [R, R, OnCleanup]) => any : (...args: [any, any, OnCleanup]) => any, options?: WatchOptions<boolean>) => WatchStopHandle |
Type Parameters
| Type Parameter | Default type |
|---|---|
P | { } |
B | { } |
D | { } |
C extends ComputedOptions | { } |
M extends MethodOptions | { } |
E extends EmitsOptions | { } |
PublicProps | { } |
Defaults | { } |
MakeDefaultsOptional extends boolean | false |
Options | ComponentOptionsBase<any, any, any, any, any, any, any, any, any> |
I extends ComponentInjectOptions | { } |
S extends SlotsType | { } |
Exposed extends string | "" |
TypeRefs extends Data | { } |
TypeEl extends Element | any |