Skip to content

Commit 794b700

Browse files
author
Will Johnston
committed
dist
1 parent 2bec47a commit 794b700

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

framework/testing/framework/platypus.d.ts

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5563,15 +5563,18 @@ declare module plat {
55635563
*/
55645564
static INJECTABLE: string;
55655565
/**
5566-
* The object resource type token.
5566+
* The object resource type token. Objects should be literal objects and won't be observed.
55675567
*/
55685568
static OBJECT: string;
55695569
/**
5570-
* The observable resource type token.
5570+
* The observable resource type token. Observable resources are expected to be
5571+
* string identifiers and will be observed.
55715572
*/
55725573
static OBSERVABLE: string;
55735574
/**
5574-
* The literal resource type token.
5575+
* The literal resource type token. Literals will be observed on the resource object,
5576+
* so if you change `resources.<alias>.value` it will be reflected everywhere it is
5577+
* observed.
55755578
*/
55765579
static LITERAL: string;
55775580
/**
@@ -5645,7 +5648,7 @@ declare module plat {
56455648
*/
56465649
static dispose(control: TemplateControl, persist?: boolean): void;
56475650
/**
5648-
* Parses a resources Element (<plat-resources>) and creates
5651+
* Parses a resources Element (`<plat-resources>`) and creates
56495652
* an IObject<IResource> with its element children.
56505653
* @param {Element} element The resources element to parse.
56515654
*/
@@ -5655,7 +5658,7 @@ declare module plat {
56555658
*/
56565659
static getInstance(): Resources;
56575660
/**
5658-
* Observes the resource if the type is 'observable'.
5661+
* Observes the resource if the type is `observable`.
56595662
* @param {plat.ui.TemplateControl} control The control in charge of the observable resource.
56605663
* @param {plat.ui.IResource} resource The resource to observe.
56615664
*/

0 commit comments

Comments
 (0)