Skip to main content

Class: HTMLSafeString

Defined in: src/drops/html_safe.ts:18

A string wrapper class used to indicate that the wrapped string is safe for output in an HTML document.

By "safe" we mean the wrapped string is trusted or has already been escaped.

Extends​

Constructors​

Constructor​

new HTMLSafeString(s): HTMLSafeString

Defined in: src/drops/html_safe.ts:21

Parameters​

s​

string

Returns​

HTMLSafeString

Overrides​

Drop.constructor

Accessors​

[toStringTag]​

Get Signature​

get [toStringTag](): string

Defined in: src/drops/html_safe.ts:35

Returns​

string

Methods​

[asyncIterator]()​

[asyncIterator](): AsyncGenerator<unknown, void, void>

Defined in: src/drop.ts:83

Returns​

AsyncGenerator<unknown, void, void>

Inherited from​

Drop.[asyncIterator]

[contains]()​

[contains](obj, context): Promise<boolean>

Defined in: src/drop.ts:35

Parameters​

obj​

unknown

context​

RenderContext

Returns​

Promise<boolean>

Inherited from​

Drop.[contains]

[containsSync]()​

[containsSync](obj, context): boolean

Defined in: src/drop.ts:39

Parameters​

obj​

unknown

context​

RenderContext

Returns​

boolean

Inherited from​

Drop.[containsSync]

[dispatch]()​

[dispatch](name, context): Promise<unknown>

Defined in: src/drop.ts:43

Parameters​

name​

string

context​

RenderContext

Returns​

Promise<unknown>

Inherited from​

Drop.[dispatch]

[dispatchSync]()​

[dispatchSync](name, context): unknown

Defined in: src/drop.ts:47

Parameters​

name​

string

context​

RenderContext

Returns​

unknown

Inherited from​

Drop.[dispatchSync]

[equals]()​

[equals](obj, context): boolean

Defined in: src/drop.ts:51

Parameters​

obj​

unknown

context​

RenderContext

Returns​

boolean

Inherited from​

Drop.[equals]

[isInvocable]()​

[isInvocable](name): boolean

Defined in: src/drop.ts:55

Parameters​

name​

string

Returns​

boolean

Inherited from​

Drop.[isInvocable]

[iterator]()​

[iterator](): Iterator<unknown>

Defined in: src/drop.ts:85

Returns​

Iterator<unknown>

Inherited from​

Drop.[iterator]

[length]()​

[length](): number

Defined in: src/drop.ts:59

Returns​

number

Inherited from​

Drop.[length]

[lessThan]()​

[lessThan](obj, context): Promise<boolean>

Defined in: src/drop.ts:63

Parameters​

obj​

unknown

context​

RenderContext

Returns​

Promise<boolean>

Inherited from​

Drop.[lessThan]

[lessThanSync]()​

[lessThanSync](obj, context): boolean

Defined in: src/drop.ts:67

Parameters​

obj​

unknown

context​

RenderContext

Returns​

boolean

Inherited from​

Drop.[lessThanSync]

[slice]()​

[slice](offset?, limit?, reversed?): Promise<Drop>

Defined in: src/drop.ts:71

Parameters​

offset?​

number

limit?​

number

reversed?​

boolean

Returns​

Promise<Drop>

Inherited from​

Drop.[slice]

[sliceSync]()​

[sliceSync](offset?, limit?, reversed?): Drop

Defined in: src/drop.ts:79

Parameters​

offset?​

number

limit?​

number

reversed?​

boolean

Returns​

Drop

Inherited from​

Drop.[sliceSync]

[toHTMLSafeString]()​

[toHTMLSafeString](context): Promise<string | undefined>

Defined in: src/drop.ts:107

Parameters​

context​

RenderContext

Returns​

Promise<string | undefined>

Inherited from​

Drop.[toHTMLSafeString]

[toHTMLSafeStringSync]()​

[toHTMLSafeStringSync](context): string

Defined in: src/drops/html_safe.ts:57

Parameters​

context​

RenderContext

Returns​

string

Overrides​

Drop.[toHTMLSafeStringSync]

[toLiquid]()​

[toLiquid](hint): Promise<unknown>

Defined in: src/drops/html_safe.ts:39

Parameters​

hint​

ContextHint

Returns​

Promise<unknown>

Overrides​

Drop.[toLiquid]

[toLiquidSync]()​

[toLiquidSync](hint): unknown

Defined in: src/drops/html_safe.ts:43

Parameters​

hint​

ContextHint

Returns​

unknown

Overrides​

Drop.[toLiquidSync]

toString()​

toString(): string

Defined in: src/drop.ts:117

Returns​

string

Inherited from​

Drop.toString

valueOf()​

valueOf(): string

Defined in: src/drops/html_safe.ts:61

Returns the primitive value of the specified object.

Returns​

string

escape()​

static escape(value): HTMLSafeString

Defined in: src/drops/html_safe.ts:26

Parameters​

value​

string | HTMLSafeString

Returns​

HTMLSafeString

from()​

static from(s): HTMLSafeString

Defined in: src/drops/html_safe.ts:31

Parameters​

s​

string | HTMLSafeString

Returns​

HTMLSafeString