Configuration for a route, stripped down version of the actial config used in "vue-router".
A unique ID generated from the current time, an incrementing counter and some random elements.
A generator for {@link Snowflake | Snowflakes}
Declares a Vue property. Boolean flavor of {@link Prop | @Prop} decorator
The property options to pass to vue, it can either be a constructor function like String or Number, an array of constructor functions or a property object RecordPropOpts. If a property object is given, in addition to the normal vue options some additional values can be provided.
Marks a function as blocking, setting a BusyState while in execution and automatically blocking other functions marked with {@Blocking}, supports both synchronous and asynchronous processes.
The id of the blocking process, if there are multiple non-conflicting processes.
Binds a busy state used by Blocking methods to a vue reactive variable.
The identifier of a block state, if multiple exist.
Prefixes a css classes getter keys with a given prefix and adds a css class to its body. supports transforming object keys for conventional class names.
The class prefix to prefix object keys with. If none is given, it will default to the converted class name.
The infix to insert between prefix and key. By default this will be an empty string.
The converter used to convert object keys with. By default it does nothing.
Camel case specific flavor of Classes decorator. Prefixes a css classes getter keys with a given prefix and adds a css class to its body. transforms the class name to camelCase and all members to PascalCase.
The class prefix to prefix object keys with. If none is given, it will default to the converted class name.
The infix to insert between prefix and key. By default this will be an empty string.
Kebap case specific flavor of Classes decorator. Prefixes a css classes getter keys with a given prefix and adds a css class to its body. transforms the class name and all members to kebap-case.
The class prefix to prefix object keys with. If none is given, it will default to the converted class name.
The infix to insert between prefix and key.
By default this will be two dashes (--).
Pascal case specific flavor of Classes decorator. Prefixes a css classes getter keys with a given prefix and adds a css class to its body. transforms the class name and all members to PascalCase.
The class prefix to prefix object keys with. If none is given, it will default to the converted class name.
The infix to insert between prefix and key. By default this will be an empty string.
Snake case specific flavor of Classes decorator. Prefixes a css classes getter keys with a given prefix and adds a css class to its body. transforms the class name and all members to snake_case.
The class prefix to prefix object keys with. If none is given, it will default to the converted class name.
The infix to insert between prefix and key.
By default this will be two dashes (--).
Declares a Vue property. Date flavor of {@link Prop | @Prop} decorator
The property options to pass to vue, it can either be a constructor function like String or Number, an array of constructor functions or a property object RecordPropOpts. If a property object is given, in addition to the normal vue options some additional values can be provided.
Watch a property for changes, deeply
The property to watch
Declares a Vue data property.
The data property options.
Debounce function calls by a specified amount of time
The function will only be executed ms milliseconds after
the last invocation. If it is invoked again within this
timeframe, the timeframe is reset. Useful for search completion.
The amount of milliseconds to debounce it by
Debuffer function calls by a specified amount of time
The function will only be executed every ms milliseconds
Every call within this timeframe are blocked and the timeframe
reset. Useful for possible multiple event triggersn.
The amount of milliseconds to debuffer it by
Delay function calls by a specified amount of time.
The milliseconds to delay calls by.
Creates a computed property for {@link Document#querySelector} or {@link Document#querySelectorAll}
The css selector to pass to {@link Document#querySelector} or {@link Document#querySelectorAll}
If {@link Document#querySelectorAll} should be used
Creates a computed property for {@link Vue#$el#querySelector | this.$el.querySelector} or {@link Vue#$el#querySelectorAll | this.$el.querySelectorAll}
The css selector to pass to {@link Vue#$el#querySelector | this.$el.querySelector} or {@link Vue#$el#querySelectorAll | this.$el.querySelectorAll}
If {@link Vue#$el#querySelectorAll | this.$el.querySelectorAll} should be used
Emits a given vue event after execution with the return value being the event parameter.
The name of the event to trigger, defaults to the method name
Emits a given vue event after failed execution with the error being the event parameter.
The name of the event to trigger, defaults to error:METHODNAME
where METHODNAME is the name of the decorated method.
If the error should be re-thrown after emitting the event
Emits a given vue event after the execution of the decorated method, if a status code can be extracted from its return value or error.
The status code to match, if none is given, it will emit on every status code
The name of the event to trigger, defaults to status:STATUSCODE
where STATUSCODE is the status code extracted from the return value or error of the decorated method.
If the error should be re-thrown after emitting the event
Calls a function every ms milliseconds.
The milliseconds between executions
Calls a function every animation frame.
Watch a property for changes, deeply and immediately
The property to watch
Watch a property for changes, immediately
The property to watch
Wraps a function and only calls through if a given set of predicates return truthy
The predicates to check before executing the decorated function
Wraps a function and only calls through if a given set of predicates return falsy
The predicates to check before executing the decorated function
Limit function calls to browser frames. Useful for animations. Every subsequent call before the next frame is blocked.
Declares a Vue property. Number flavor of {@link Prop | @Prop} decorator
The property options to pass to vue, it can either be a constructor function like String or Number, an array of constructor functions or a property object RecordPropOpts. If a property object is given, in addition to the normal vue options some additional values can be provided.
Delay function calls by a single browser frame.
Delay function calls by a millisecond.
Delay function calls by a vue tick using this.$nextTick.
Registers the decorated method as a vue event listener. if more than one event is given, it will listen for multiple events All event parameters are passed as arguments to the decorated method.
The events to listen for
Registers the decorated method as a dom event listener for the document object. if more than one event is given, it will listen for multiple events All event parameters are passed as arguments to the decorated method.
The events to listen for
Registers the decorated method as a dom event listener. if more than one event is given, it will listen for multiple events All event parameters are passed as arguments to the decorated method.
The events to listen for
Registers the decorated method as a vue event listener of the parent vue component. if more than one event is given, it will listen for multiple events All event parameters are passed as arguments to the decorated method.
The events to listen for
Registers the decorated method as a dom event listener for the parent vue component. if more than one event is given, it will listen for multiple events All event parameters are passed as arguments to the decorated method.
The events to listen for
Registers the decorated method as a dom event listener for the window object. if more than one event is given, it will listen for multiple events All event parameters are passed as arguments to the decorated method.
The events to listen for
Creates a computed property for {@link Vue#$el#querySelector | this.$parent.$el.querySelector} or {@link Vue#$el#querySelectorAll | this.$parent.$el.querySelectorAll}
The css selector to pass to {@link Vue#$el#querySelector | this.$parent.$el.querySelector} or {@link Vue#$el#querySelectorAll | this.$parent.$el.querySelectorAll}
If {@link Vue#$el#querySelectorAll | this.$parent.$el.querySelectorAll} should be used
Declares a Vue property.
The property options to pass to vue, it can either be a constructor function like String or Number, an array of constructor functions or a property object RecordPropOpts. If a property object is given, in addition to the normal vue options some additional values can be provided.
an optional type override if no type is specified using both provided options or reflected decorator metadata.
Creates an accessor to a Vue reference.
The reference to bind to.
Registers a route for a given component Decorator for components
A route string or vue route config
Binds the current route name to a class member. Decorator for properties. On setting the decorated property, a navigation will occur to the set route name using {@link Router#replace}.
Binds a route param to a class member. Decorator for properties. On setting the decorated property, a navigation will occur to the current route with new params using {@link Router#replace}.
Binds a route query to a class member. Decorator for properties. On setting the decorated property, a navigation will occur to the current route with new query using {@link Router#replace}.
Declares a Vue property. String flavor of {@link Prop | @Prop} decorator
The property options to pass to vue, it can either be a constructor function like String or Number, an array of constructor functions or a property object RecordPropOpts. If a property object is given, in addition to the normal vue options some additional values can be provided.
Watch a property for changes
The property to watch
Creates an observable state for the decorated property. Every decorated property can then be used reactively in a vue context.
The state options, default being the default value or a
factory returning it, literal being the absolute default value,
functions being passed as is.
Creates a key converter function for use in Classes.
The transformation to apply to the class name
The transformation to apply to the object key
Classes ClassesCamel ClassesKebap ClassesPascal ClassesSnake
Merges multiple predicates into one.
The predicates to combine
A predicate that returns true if all other predicates have returned true.
Create a predicate that checks if the first parameter of the returned function is equal to a given value at a certain json path.
the path to look up in the returned object.
the value to check equality against.
A predicate for use in @If and @IfNot
A predicate that checks if the first parameter (assumed event) is the first child of its parent node.
The event to check against
true, if the event's target is the first child of its parent.
A predicate that checks if the first parameter (assumed event) is the first child element of its parent element.
The event to check against
true, if the event's target is the first child of its parent.
Creates a predicate that checks if its first parameter (assumed event) has one or more given vue refs in its {@link Event#composedPath | composedPath}.
The vue refs to check against
A predicate that returns true if all refs are part of the events composedPath.
A predicate that checks if the first parameter (assumed event) is the last child of its parent node.
The event to check against
true, if the event's target is the last child of its parent.
A predicate that checks if the first parameter (assumed event) is the last child element of its parent element.
The event to check against
true, if the event's target is the last child of its parent.
Creates a predicate that checks if its first parameter (assumed event) has one or more given vue refs in its {@link Event#composedPath | composedPath}.
The vue refs to check against
A predicate that returns true if one of all refs are part of the events composedPath.
Create a predicate that checks if the first parameter of the returned function is equal to one of many a given values at a certain json path.
the path to look up in the returned object.
the value to check equality against.
A predicate for use in @If and @IfNot
Creates a predicate that checks if the first parameter (assumed event) is a key event matching one of a given set of keys.
The keys to check against
A predicate that returns true, if the event key is one of the given keys.
Creates a predicate that checks if the first parameter (assumed event) is a key event matching one of a given set of mouse buttons.
The mouse buttons to check against
A predicate that returns true, if the event button is one of the given mouse buttons.
Inverts a given predicate (negates its output)
The predicate to invert
The negated predicate.
Merges multiple predicates into one.
The predicates to combine
A predicate that returns true if one of the given predicates returns true.
A predicate that checks if the first parameter (assumed event) was prevented with {@link Event#preventDefault | preventDefault}.
The event to check against
true, if event was prevented before.
Generated using TypeDoc
Parameters of the {@link Prop | @Prop} decorator and its flavors