Skip to content

Commit

Permalink
docs(*): regenerate reference documentation again
Browse files Browse the repository at this point in the history
  • Loading branch information
jo3-l committed Jan 5, 2024
1 parent 0b48eca commit 5bb1ef1
Show file tree
Hide file tree
Showing 19 changed files with 78 additions and 78 deletions.
56 changes: 28 additions & 28 deletions docs/reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Context passed to [[TextCensorStrategy | text censoring strategies]].

#### Defined in

[src/censor/TextCensor.ts:104](https://github.com/jo3-l/obscenity/blob/6cfee56/src/censor/TextCensor.ts#L104)
[src/censor/TextCensor.ts:104](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/TextCensor.ts#L104)

___

Expand All @@ -92,7 +92,7 @@ should be a set of characters that map to the transformed character.

#### Defined in

[src/transformer/remap-characters/index.ts:60](https://github.com/jo3-l/obscenity/blob/6cfee56/src/transformer/remap-characters/index.ts#L60)
[src/transformer/remap-characters/index.ts:60](https://github.com/jo3-l/obscenity/blob/0b48eca/src/transformer/remap-characters/index.ts#L60)

___

Expand All @@ -104,7 +104,7 @@ All the profane words that are included in the [[englishDataset | english datase

#### Defined in

[src/preset/english.ts:383](https://github.com/jo3-l/obscenity/blob/6cfee56/src/preset/english.ts#L383)
[src/preset/english.ts:383](https://github.com/jo3-l/obscenity/blob/0b48eca/src/preset/english.ts#L383)

___

Expand All @@ -122,7 +122,7 @@ Extends the default match payload by adding phrase metadata.

#### Defined in

[src/dataset/DataSet.ts:190](https://github.com/jo3-l/obscenity/blob/6cfee56/src/dataset/DataSet.ts#L190)
[src/dataset/DataSet.ts:190](https://github.com/jo3-l/obscenity/blob/0b48eca/src/dataset/DataSet.ts#L190)

___

Expand All @@ -134,7 +134,7 @@ All the possible kinds of nodes.

#### Defined in

[src/pattern/Nodes.ts:24](https://github.com/jo3-l/obscenity/blob/6cfee56/src/pattern/Nodes.ts#L24)
[src/pattern/Nodes.ts:24](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/Nodes.ts#L24)

___

Expand All @@ -161,7 +161,7 @@ replacement string.

#### Defined in

[src/censor/TextCensor.ts:99](https://github.com/jo3-l/obscenity/blob/6cfee56/src/censor/TextCensor.ts#L99)
[src/censor/TextCensor.ts:99](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/TextCensor.ts#L99)

## Variables

Expand Down Expand Up @@ -222,7 +222,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#### Defined in

[src/preset/english.ts:103](https://github.com/jo3-l/obscenity/blob/6cfee56/src/preset/english.ts#L103)
[src/preset/english.ts:103](https://github.com/jo3-l/obscenity/blob/0b48eca/src/preset/english.ts#L103)

___

Expand All @@ -235,7 +235,7 @@ A set of transformers to be used when matching blacklisted patterns with the

#### Defined in

[src/preset/english.ts:13](https://github.com/jo3-l/obscenity/blob/6cfee56/src/preset/english.ts#L13)
[src/preset/english.ts:13](https://github.com/jo3-l/obscenity/blob/0b48eca/src/preset/english.ts#L13)

___

Expand All @@ -248,7 +248,7 @@ dataset]] and the [[RegExpMatcher]].

#### Defined in

[src/preset/english.ts:48](https://github.com/jo3-l/obscenity/blob/6cfee56/src/preset/english.ts#L48)
[src/preset/english.ts:48](https://github.com/jo3-l/obscenity/blob/0b48eca/src/preset/english.ts#L48)

___

Expand All @@ -261,7 +261,7 @@ A set of transformers to be used when matching whitelisted terms with the

#### Defined in

[src/preset/english.ts:36](https://github.com/jo3-l/obscenity/blob/6cfee56/src/preset/english.ts#L36)
[src/preset/english.ts:36](https://github.com/jo3-l/obscenity/blob/0b48eca/src/preset/english.ts#L36)

___

Expand All @@ -273,7 +273,7 @@ The current version of the library, formatted as `MAJOR.MINOR.PATCH`.

#### Defined in

[src/index.ts:27](https://github.com/jo3-l/obscenity/blob/6cfee56/src/index.ts#L27)
[src/index.ts:27](https://github.com/jo3-l/obscenity/blob/0b48eca/src/index.ts#L27)

## Functions

Expand Down Expand Up @@ -312,7 +312,7 @@ to the [[RegExpMatcher]].

#### Defined in

[src/matcher/BlacklistedTerm.ts:37](https://github.com/jo3-l/obscenity/blob/6cfee56/src/matcher/BlacklistedTerm.ts#L37)
[src/matcher/BlacklistedTerm.ts:37](https://github.com/jo3-l/obscenity/blob/0b48eca/src/matcher/BlacklistedTerm.ts#L37)

___

Expand All @@ -339,7 +339,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].

#### Defined in

[src/censor/BuiltinStrategies.ts:71](https://github.com/jo3-l/obscenity/blob/6cfee56/src/censor/BuiltinStrategies.ts#L71)
[src/censor/BuiltinStrategies.ts:71](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L71)

___

Expand Down Expand Up @@ -402,7 +402,7 @@ A container holding the transformer, which can then be passed to the

#### Defined in

[src/transformer/collapse-duplicates/index.ts:46](https://github.com/jo3-l/obscenity/blob/6cfee56/src/transformer/collapse-duplicates/index.ts#L46)
[src/transformer/collapse-duplicates/index.ts:46](https://github.com/jo3-l/obscenity/blob/0b48eca/src/transformer/collapse-duplicates/index.ts#L46)

___

Expand Down Expand Up @@ -443,7 +443,7 @@ than the first.

#### Defined in

[src/matcher/MatchPayload.ts:57](https://github.com/jo3-l/obscenity/blob/6cfee56/src/matcher/MatchPayload.ts#L57)
[src/matcher/MatchPayload.ts:57](https://github.com/jo3-l/obscenity/blob/0b48eca/src/matcher/MatchPayload.ts#L57)

___

Expand Down Expand Up @@ -477,7 +477,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].

#### Defined in

[src/censor/BuiltinStrategies.ts:134](https://github.com/jo3-l/obscenity/blob/6cfee56/src/censor/BuiltinStrategies.ts#L134)
[src/censor/BuiltinStrategies.ts:134](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L134)

___

Expand Down Expand Up @@ -521,7 +521,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].

#### Defined in

[src/censor/BuiltinStrategies.ts:115](https://github.com/jo3-l/obscenity/blob/6cfee56/src/censor/BuiltinStrategies.ts#L115)
[src/censor/BuiltinStrategies.ts:115](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L115)

___

Expand Down Expand Up @@ -550,7 +550,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].

#### Defined in

[src/censor/BuiltinStrategies.ts:89](https://github.com/jo3-l/obscenity/blob/6cfee56/src/censor/BuiltinStrategies.ts#L89)
[src/censor/BuiltinStrategies.ts:89](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L89)

___

Expand Down Expand Up @@ -584,7 +584,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].

#### Defined in

[src/censor/BuiltinStrategies.ts:51](https://github.com/jo3-l/obscenity/blob/6cfee56/src/censor/BuiltinStrategies.ts#L51)
[src/censor/BuiltinStrategies.ts:51](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L51)

___

Expand Down Expand Up @@ -629,7 +629,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].

#### Defined in

[src/censor/BuiltinStrategies.ts:28](https://github.com/jo3-l/obscenity/blob/6cfee56/src/censor/BuiltinStrategies.ts#L28)
[src/censor/BuiltinStrategies.ts:28](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L28)

___

Expand Down Expand Up @@ -664,7 +664,7 @@ The parsed pattern, which can then be used with the

#### Defined in

[src/pattern/Pattern.ts:130](https://github.com/jo3-l/obscenity/blob/6cfee56/src/pattern/Pattern.ts#L130)
[src/pattern/Pattern.ts:130](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/Pattern.ts#L130)

___

Expand Down Expand Up @@ -797,7 +797,7 @@ The parsed pattern, which can then be used with the

#### Defined in

[src/pattern/Pattern.ts:106](https://github.com/jo3-l/obscenity/blob/6cfee56/src/pattern/Pattern.ts#L106)
[src/pattern/Pattern.ts:106](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/Pattern.ts#L106)

___

Expand Down Expand Up @@ -831,7 +831,7 @@ A [[TextCensorStrategy]] for use with the [[TextCensor]].

#### Defined in

[src/censor/BuiltinStrategies.ts:155](https://github.com/jo3-l/obscenity/blob/6cfee56/src/censor/BuiltinStrategies.ts#L155)
[src/censor/BuiltinStrategies.ts:155](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/BuiltinStrategies.ts#L155)

___

Expand Down Expand Up @@ -891,7 +891,7 @@ A container holding the transformer, which can then be passed to the

#### Defined in

[src/transformer/remap-characters/index.ts:38](https://github.com/jo3-l/obscenity/blob/6cfee56/src/transformer/remap-characters/index.ts#L38)
[src/transformer/remap-characters/index.ts:38](https://github.com/jo3-l/obscenity/blob/0b48eca/src/transformer/remap-characters/index.ts#L38)

___

Expand Down Expand Up @@ -924,7 +924,7 @@ A container holding the transformer, which can then be passed to the

#### Defined in

[src/transformer/resolve-confusables/index.ts:22](https://github.com/jo3-l/obscenity/blob/6cfee56/src/transformer/resolve-confusables/index.ts#L22)
[src/transformer/resolve-confusables/index.ts:22](https://github.com/jo3-l/obscenity/blob/0b48eca/src/transformer/resolve-confusables/index.ts#L22)

___

Expand Down Expand Up @@ -958,7 +958,7 @@ A container holding the transformer, which can then be passed to the

#### Defined in

[src/transformer/resolve-leetspeak/index.ts:23](https://github.com/jo3-l/obscenity/blob/6cfee56/src/transformer/resolve-leetspeak/index.ts#L23)
[src/transformer/resolve-leetspeak/index.ts:23](https://github.com/jo3-l/obscenity/blob/0b48eca/src/transformer/resolve-leetspeak/index.ts#L23)

___

Expand Down Expand Up @@ -1000,7 +1000,7 @@ A container holding the transformer, which can then be passed to the

#### Defined in

[src/transformer/skip-non-alphabetic/index.ts:31](https://github.com/jo3-l/obscenity/blob/6cfee56/src/transformer/skip-non-alphabetic/index.ts#L31)
[src/transformer/skip-non-alphabetic/index.ts:31](https://github.com/jo3-l/obscenity/blob/0b48eca/src/transformer/skip-non-alphabetic/index.ts#L31)

___

Expand All @@ -1027,4 +1027,4 @@ A container holding the transformer, which can then be passed to the

#### Defined in

[src/transformer/to-ascii-lowercase/index.ts:18](https://github.com/jo3-l/obscenity/blob/6cfee56/src/transformer/to-ascii-lowercase/index.ts#L18)
[src/transformer/to-ascii-lowercase/index.ts:18](https://github.com/jo3-l/obscenity/blob/0b48eca/src/transformer/to-ascii-lowercase/index.ts#L18)
10 changes: 5 additions & 5 deletions docs/reference/classes/DataSet.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ const customDataset = new DataSet().addAll(englishDataset);

#### Defined in

[src/dataset/DataSet.ts:29](https://github.com/jo3-l/obscenity/blob/6cfee56/src/dataset/DataSet.ts#L29)
[src/dataset/DataSet.ts:29](https://github.com/jo3-l/obscenity/blob/0b48eca/src/dataset/DataSet.ts#L29)

___

Expand Down Expand Up @@ -96,7 +96,7 @@ const data = new DataSet<{ originalWord: string }>()

#### Defined in

[src/dataset/DataSet.ts:75](https://github.com/jo3-l/obscenity/blob/6cfee56/src/dataset/DataSet.ts#L75)
[src/dataset/DataSet.ts:75](https://github.com/jo3-l/obscenity/blob/0b48eca/src/dataset/DataSet.ts#L75)

___

Expand All @@ -122,7 +122,7 @@ const matcher = new RegExpMatcher({

#### Defined in

[src/dataset/DataSet.ts:118](https://github.com/jo3-l/obscenity/blob/6cfee56/src/dataset/DataSet.ts#L118)
[src/dataset/DataSet.ts:118](https://github.com/jo3-l/obscenity/blob/0b48eca/src/dataset/DataSet.ts#L118)

___

Expand Down Expand Up @@ -154,7 +154,7 @@ const phraseMetadata = matchesWithPhraseMetadata[0].phraseMetadata;

#### Defined in

[src/dataset/DataSet.ts:94](https://github.com/jo3-l/obscenity/blob/6cfee56/src/dataset/DataSet.ts#L94)
[src/dataset/DataSet.ts:94](https://github.com/jo3-l/obscenity/blob/0b48eca/src/dataset/DataSet.ts#L94)

___

Expand Down Expand Up @@ -184,4 +184,4 @@ const customDataset = new DataSet<{ originalWord: string }>()

#### Defined in

[src/dataset/DataSet.ts:46](https://github.com/jo3-l/obscenity/blob/6cfee56/src/dataset/DataSet.ts#L46)
[src/dataset/DataSet.ts:46](https://github.com/jo3-l/obscenity/blob/0b48eca/src/dataset/DataSet.ts#L46)
8 changes: 4 additions & 4 deletions docs/reference/classes/ParserError.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Error.constructor

#### Defined in

[src/pattern/ParserError.ts:18](https://github.com/jo3-l/obscenity/blob/6cfee56/src/pattern/ParserError.ts#L18)
[src/pattern/ParserError.ts:18](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/ParserError.ts#L18)

## Properties

Expand All @@ -57,7 +57,7 @@ Note that surrogate pairs are counted as 1 column wide, not 2.

#### Defined in

[src/pattern/ParserError.ts:16](https://github.com/jo3-l/obscenity/blob/6cfee56/src/pattern/ParserError.ts#L16)
[src/pattern/ParserError.ts:16](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/ParserError.ts#L16)

___

Expand All @@ -69,7 +69,7 @@ The line on which the error occurred (one-based).

#### Defined in

[src/pattern/ParserError.ts:10](https://github.com/jo3-l/obscenity/blob/6cfee56/src/pattern/ParserError.ts#L10)
[src/pattern/ParserError.ts:10](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/ParserError.ts#L10)

___

Expand Down Expand Up @@ -97,7 +97,7 @@ Error.name

#### Defined in

[src/pattern/ParserError.ts:5](https://github.com/jo3-l/obscenity/blob/6cfee56/src/pattern/ParserError.ts#L5)
[src/pattern/ParserError.ts:5](https://github.com/jo3-l/obscenity/blob/0b48eca/src/pattern/ParserError.ts#L5)

___

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/classes/PhraseBuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Associates a pattern with this phrase.

#### Defined in

[src/dataset/DataSet.ts:149](https://github.com/jo3-l/obscenity/blob/6cfee56/src/dataset/DataSet.ts#L149)
[src/dataset/DataSet.ts:149](https://github.com/jo3-l/obscenity/blob/0b48eca/src/dataset/DataSet.ts#L149)

___

Expand All @@ -77,7 +77,7 @@ Associates a whitelisted pattern with this phrase.

#### Defined in

[src/dataset/DataSet.ts:159](https://github.com/jo3-l/obscenity/blob/6cfee56/src/dataset/DataSet.ts#L159)
[src/dataset/DataSet.ts:159](https://github.com/jo3-l/obscenity/blob/0b48eca/src/dataset/DataSet.ts#L159)

___

Expand All @@ -94,7 +94,7 @@ Builds the phrase, returning a [[PhraseContainer]] for use with the

#### Defined in

[src/dataset/DataSet.ts:178](https://github.com/jo3-l/obscenity/blob/6cfee56/src/dataset/DataSet.ts#L178)
[src/dataset/DataSet.ts:178](https://github.com/jo3-l/obscenity/blob/0b48eca/src/dataset/DataSet.ts#L178)

___

Expand All @@ -116,4 +116,4 @@ Associates some metadata with this phrase.

#### Defined in

[src/dataset/DataSet.ts:169](https://github.com/jo3-l/obscenity/blob/6cfee56/src/dataset/DataSet.ts#L169)
[src/dataset/DataSet.ts:169](https://github.com/jo3-l/obscenity/blob/0b48eca/src/dataset/DataSet.ts#L169)
6 changes: 3 additions & 3 deletions docs/reference/classes/RegExpMatcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ console.log(matcher.getAllMatches('fu.....uuuuCK the pen is mightier than the sw

#### Defined in

[src/matcher/regexp/RegExpMatcher.ts:74](https://github.com/jo3-l/obscenity/blob/6cfee56/src/matcher/regexp/RegExpMatcher.ts#L74)
[src/matcher/regexp/RegExpMatcher.ts:74](https://github.com/jo3-l/obscenity/blob/0b48eca/src/matcher/regexp/RegExpMatcher.ts#L74)

## Methods

Expand Down Expand Up @@ -121,7 +121,7 @@ otherwise, their order is unspecified.

#### Defined in

[src/matcher/regexp/RegExpMatcher.ts:86](https://github.com/jo3-l/obscenity/blob/6cfee56/src/matcher/regexp/RegExpMatcher.ts#L86)
[src/matcher/regexp/RegExpMatcher.ts:86](https://github.com/jo3-l/obscenity/blob/0b48eca/src/matcher/regexp/RegExpMatcher.ts#L86)

___

Expand Down Expand Up @@ -150,4 +150,4 @@ checking the result, though it depends on the implementation.

#### Defined in

[src/matcher/regexp/RegExpMatcher.ts:116](https://github.com/jo3-l/obscenity/blob/6cfee56/src/matcher/regexp/RegExpMatcher.ts#L116)
[src/matcher/regexp/RegExpMatcher.ts:116](https://github.com/jo3-l/obscenity/blob/0b48eca/src/matcher/regexp/RegExpMatcher.ts#L116)
4 changes: 2 additions & 2 deletions docs/reference/classes/TextCensor.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The censored text.

#### Defined in

[src/censor/TextCensor.ts:66](https://github.com/jo3-l/obscenity/blob/6cfee56/src/censor/TextCensor.ts#L66)
[src/censor/TextCensor.ts:66](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/TextCensor.ts#L66)

___

Expand Down Expand Up @@ -104,4 +104,4 @@ utility functions:

#### Defined in

[src/censor/TextCensor.ts:41](https://github.com/jo3-l/obscenity/blob/6cfee56/src/censor/TextCensor.ts#L41)
[src/censor/TextCensor.ts:41](https://github.com/jo3-l/obscenity/blob/0b48eca/src/censor/TextCensor.ts#L41)
Loading

0 comments on commit 5bb1ef1

Please sign in to comment.