Skip to content

Commit 5378cfe

Browse files
committed
Make SafeString show up correctly in docs
1 parent 730ae35 commit 5378cfe

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

packages/@ember/-internals/glimmer/lib/utils/string.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,10 @@ import type { SafeString as GlimmerSafeString } from '@glimmer/runtime';
3232
htmlSafe(someTrustedorSanitizedString);
3333
```
3434
35-
@public
36-
@since 4.12.0
35+
@for @ember/template
3736
@class SafeString
37+
@since 4.12.0
38+
@public
3839
*/
3940
export class SafeString implements GlimmerSafeString {
4041
private __string: string;
@@ -48,7 +49,7 @@ export class SafeString implements GlimmerSafeString {
4849
4950
@public
5051
@method toString
51-
@returns The string marked as trusted
52+
@returns {String} The string marked as trusted
5253
*/
5354
toString(): string {
5455
return `${this.__string}`;
@@ -59,7 +60,7 @@ export class SafeString implements GlimmerSafeString {
5960
6061
@public
6162
@method toHTML
62-
@returns string
63+
@returns {String} the trusted string, without any escaping applied
6364
*/
6465
toHTML(): string {
6566
return this.toString();

tests/docs/expected.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,7 @@ module.exports = {
509509
'toArray',
510510
'toggleProperty',
511511
'toString',
512+
'toHTML',
512513
'tracked',
513514
'transitionTo',
514515
'transitionToRoute',

0 commit comments

Comments
 (0)