Skip to content

Latest commit

 

History

History
119 lines (67 loc) · 2.41 KB

PhraseBuilder.md

File metadata and controls

119 lines (67 loc) · 2.41 KB

obscenity / PhraseBuilder

Class: PhraseBuilder<MetadataType>

Builder for phrases.

Type parameters

Name
MetadataType

Table of contents

Constructors

Methods

Constructors

constructor

new PhraseBuilder<MetadataType>()

Type parameters

Name
MetadataType

Methods

addPattern

addPattern(pattern): PhraseBuilder<MetadataType>

Associates a pattern with this phrase.

Parameters

Name Type Description
pattern ParsedPattern Pattern to add.

Returns

PhraseBuilder<MetadataType>

Defined in

src/dataset/DataSet.ts:149


addWhitelistedTerm

addWhitelistedTerm(term): PhraseBuilder<MetadataType>

Associates a whitelisted pattern with this phrase.

Parameters

Name Type Description
term string Whitelisted term to add.

Returns

PhraseBuilder<MetadataType>

Defined in

src/dataset/DataSet.ts:159


build

build(): PhraseContainer<MetadataType>

Builds the phrase, returning a [[PhraseContainer]] for use with the [[DataSet]].

Returns

PhraseContainer<MetadataType>

Defined in

src/dataset/DataSet.ts:178


setMetadata

setMetadata(metadata?): PhraseBuilder<MetadataType>

Associates some metadata with this phrase.

Parameters

Name Type Description
metadata? MetadataType Metadata to use.

Returns

PhraseBuilder<MetadataType>

Defined in

src/dataset/DataSet.ts:169