Class HashMentionFormat

Hierarchy (View Summary)

MentionFormat
- HashMentionFormat

Index

Constructors

Properties

extendable instances? mentionables

Methods

extend format getMentionable makeMentionables queryFromTyped trigger

Constructors

constructor

new HashMentionFormat(): HashMentionFormat

Returns HashMentionFormat

Inherited from MentionFormat.constructor

Properties

`Protected`extendable

extendable: boolean = true

`Protected` `Optional`instances

instances?: MentionableModel<Model, MentionFormat>[]

mentionables

mentionables: (new (...args: any[]) => MentionableModel)[] = ...

Methods

extend

extend(mentionable: new (...args: any[]) => MentionableModel): void
Parameters
- mentionable: new (...args: any[]) => MentionableModel
Returns void
Inherited from MentionFormat.extend
- Defined in extensions/mentions/js/src/forum/mentionables/formats/MentionFormat.ts:15

format

format(slug: string): string
Parameters
- slug: string
Returns string
Overrides MentionFormat.format
- Defined in extensions/mentions/js/src/forum/mentionables/formats/HashMentionFormat.ts:19

getMentionable

getMentionable(type: string): MentionableModel<Model, MentionFormat> | null
Parameters
- type: string
Returns MentionableModel<Model, MentionFormat> | null
Inherited from MentionFormat.getMentionable
- Defined in extensions/mentions/js/src/forum/mentionables/formats/MentionFormat.ts:11

makeMentionables

makeMentionables(): MentionableModel<Model, MentionFormat>[]
Returns MentionableModel<Model, MentionFormat>[]
Inherited from MentionFormat.makeMentionables
- Defined in extensions/mentions/js/src/forum/mentionables/formats/MentionFormat.ts:7

queryFromTyped

queryFromTyped(typed: string): string | null
Picks the term to search in the API from the typed text. @example:
- Full text = Hello @"John D
- Typed text = "John D
- Query = John D
Parameters
- typed: string
Returns string | null
Overrides MentionFormat.queryFromTyped
- Defined in extensions/mentions/js/src/forum/mentionables/formats/HashMentionFormat.ts:13

trigger

trigger(): string
Returns string
Overrides MentionFormat.trigger
- Defined in extensions/mentions/js/src/forum/mentionables/formats/HashMentionFormat.ts:9