diff --git a/src/modules/esl-media-query/README.md b/src/modules/esl-media-query/README.md index 0b75e5d8f..1f990f131 100644 --- a/src/modules/esl-media-query/README.md +++ b/src/modules/esl-media-query/README.md @@ -209,6 +209,7 @@ ESLMediaRuleList.parse('@XS => {option: 1} | @+SM => {option: 2}', evaluate); // ESLMediaRuleList.parseTuple('@xs|@sm|@md|@lg|@xl', '1|2|3|4|5') // String payload example ESLMediaRuleList.parseTuple('@xs|@sm|@md|@lg|@xl', '1|2|3|4|5', Number) // Numeric payload sample ``` +**Note**: Method `ESLMediaRuleList.parse` is deprecated, and will be reintroduced in ESL v5.0.0 with a different signature. For now use `ESLMediaRuleList.parseTuple` or `ESLMediaRuleList.parseQuery` instead. #### ESLMediaRuleList API diff --git a/src/modules/esl-media-query/core/esl-media-rule-list.ts b/src/modules/esl-media-query/core/esl-media-rule-list.ts index 05cdfab62..3898c4d46 100644 --- a/src/modules/esl-media-query/core/esl-media-rule-list.ts +++ b/src/modules/esl-media-query/core/esl-media-rule-list.ts @@ -35,6 +35,8 @@ export class ESLMediaRuleList extends SyntheticEventTarget { public static OBJECT_PARSER = (val: string): U | undefined => evaluate(val); /** + * @deprecated Method will be reintroduced in v5.0.0 with a different signature. For now use ESLMediaRuleList.parseQuery instead + * * Creates `ESLMediaRuleList` from string query representation * Expect serialized {@link ESLMediaRule}s separated by '|' * Uses exact strings as rule list values @@ -43,6 +45,8 @@ export class ESLMediaRuleList extends SyntheticEventTarget { */ public static parse(query: string): ESLMediaRuleList; /** + * @deprecated Method will be reintroduced in v5.0.0 with a different signature. For now use ESLMediaRuleList.parseQuery instead + * * Creates `ESLMediaRuleList` from string query representation. * Expect serialized {@link ESLMediaRule}s separated by '|' * @@ -51,6 +55,8 @@ export class ESLMediaRuleList extends SyntheticEventTarget { */ public static parse(query: string, parser: RulePayloadParser): ESLMediaRuleList; /** + * @deprecated Method will be reintroduced in v5.0.0 with a different signature. For now use ESLMediaRuleList.parseTuple instead + * Creates `ESLMediaRuleList` from two strings with conditions and values sequences * * @param mask - media conditions tuple string (uses '|' as separator) @@ -63,6 +69,8 @@ export class ESLMediaRuleList extends SyntheticEventTarget { */ public static parse(mask: string, values: string): ESLMediaRuleList; /** + * @deprecated Method will be reintroduced in v5.0.0 with a different signature. For now use ESLMediaRuleList.parseTuple instead + * * Creates `ESLMediaRuleList` from two strings with conditions and values sequences * * @param mask - media conditions tuple string (uses '|' as separator)