Logo for jsDocs.io

vue-property-decorator

  • Version 9.1.2
  • Published
  • 48.9 kB
  • No dependencies
  • MIT license

Install

npm i vue-property-decorator
yarn add vue-property-decorator
pnpm add vue-property-decorator

Overview

property decorators for Vue Component

Index

Functions

Functions

function Emit

Emit: (
    event?: string
) => (_target: Vue, propertyKey: string, descriptor: any) => void;

  • decorator of an event-emitter function

    Parameter event

    The name of the event MethodDecorator

function Inject

Inject: (options?: InjectOptions | InjectKey) => any;

  • decorator of an inject

    Parameter from

    key PropertyDecorator

function InjectReactive

InjectReactive: (options?: InjectOptions | InjectKey) => any;

  • decorator of a reactive inject

    Parameter from

    key PropertyDecorator

function Model

Model: (
    event?: string,
    options?: PropOptions | Constructor[] | Constructor
) => (target: Vue, key: string) => void;

  • decorator of model

    Parameter event

    event name

    Parameter options

    options PropertyDecorator

function ModelSync

ModelSync: (
    propName: string,
    event?: string,
    options?: PropOptions | Constructor[] | Constructor
) => (target: Vue, key: string) => void;

  • decorator of synced model and prop

    Parameter propName

    the name to interface with from outside, must be different from decorated property

    Parameter event

    event name

    Parameter options

    options PropertyDecorator

function Prop

Prop: (
    options?: PropOptions | Constructor[] | Constructor
) => (target: Vue, key: string) => void;

  • decorator of a prop

    Parameter options

    the options for the prop PropertyDecorator | void

function PropSync

PropSync: (
    propName: string,
    options?: PropOptions | Constructor[] | Constructor
) => (target: Vue, key: string) => void;

  • decorator of a synced prop

    Parameter propName

    the name to interface with from outside, must be different from decorated property

    Parameter options

    the options for the synced prop PropertyDecorator | void

function Provide

Provide: (key?: string | symbol) => any;

  • decorator of a provide

    Parameter key

    key PropertyDecorator | void

function ProvideReactive

ProvideReactive: (key?: string | symbol) => any;

  • decorator of a reactive provide

    Parameter key

    key PropertyDecorator | void

function Ref

Ref: (refKey?: string) => any;

  • decorator of a ref prop

    Parameter refKey

    the ref key defined in template

function VModel

VModel: (options?: PropOptions) => any;

  • decorator for capturings v-model binding to component

    Parameter options

    the options for the prop

function Watch

Watch: (path: string, options?: WatchOptions) => any;

  • decorator of a watch function

    Parameter path

    the path or the expression to observe

    Parameter WatchOption

    MethodDecorator

Package Files (13)

Dependencies (0)

No dependencies.

Dev Dependencies (9)

Peer Dependencies (2)

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/vue-property-decorator.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/vue-property-decorator)
  • HTML
    <a href="https://www.jsdocs.io/package/vue-property-decorator"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>