Skip to content

Make @state() not appear to be deprecated. #1192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 5, 2021
Merged

Make @state() not appear to be deprecated. #1192

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions src/lib/decorators.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
*/

/*
* IMPORTANT: For compatibility with tsickle and the Closure JS compiler, all
* IMPORTANT: For compatibility with tsickle and the Closure Compiler, all
* property decorators (but not class decorators) in this file that have
* an @ExportDecoratedItems annotation must be defined as a regular function,
* not an arrow function.
Expand Down Expand Up @@ -181,10 +181,10 @@ export interface InternalPropertyDeclaration<Type = unknown> {
*
* Properties declared this way must not be used from HTML or HTML templating
* systems, they're solely for properties internal to the element. These
* properties may be renamed by optimization tools like closure compiler.
* properties may be renamed by optimization tools like the Closure Compiler.
* @category Decorator
* @deprecated `internalProperty` will be renamed to `state` in lit-element 3.0.
* Please update to `state` now to be compatible with 3.0.
* @deprecated `internalProperty` has been renamed to `state` in lit-element
* 3.0. Please update to `state` now to be compatible with 3.0.
*/
export function internalProperty(options?: InternalPropertyDeclaration) {
return property({attribute: false, hasChanged: options?.hasChanged});
Expand All @@ -196,10 +196,11 @@ export function internalProperty(options?: InternalPropertyDeclaration) {
*
* Properties declared this way must not be used from HTML or HTML templating
* systems, they're solely for properties internal to the element. These
* properties may be renamed by optimization tools like closure compiler.
* properties may be renamed by optimization tools like the Closure Compiler.
* @category Decorator
*/
export const state = internalProperty;
export const state = (options?: InternalPropertyDeclaration) =>
internalProperty(options);

/**
* A property decorator that converts a class property into a getter that
Expand Down