MatchPayload.md

obscenity / MatchPayload

Interface: MatchPayload

Information emitted on a successful match.

If you require more information about matches than what is provided here, see the [[DataSet]] class, which supports associating metadata with patterns.

Table of contents

Properties

• endIndex
• matchLength
• startIndex
• termId

Properties

endIndex

• endIndex: number

End index of the match, inclusive.

If the last character of the pattern is a surrogate pair, then this points to the index of the low surrogate.

Defined in

src/matcher/MatchPayload.ts:16

---

matchLength

• matchLength: number

Total number of of code points that matched.

Defined in

src/matcher/MatchPayload.ts:21

---

startIndex

• startIndex: number

Start index of the match, inclusive.

Defined in

src/matcher/MatchPayload.ts:26

---

termId

• termId: number

ID of the blacklisted term that matched.

Defined in

src/matcher/MatchPayload.ts:31