de-compromise

https://github.com/nlp-compromise/de-compromise
Admin
de-compromise is a German port of the compromise library, providing a small, basic, rule-based...
Tokens:56,520
Snippets:458
Trust Score:7.5
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Clone, install, test, and watch de-compromise

Source: https://github.com/nlp-compromise/de-compromise/blob/main/README.md

Commands to set up the de-compromise repository for development: clone the repo, change into the directory, install dependencies, run tests, and start the watch mode.

```bash
git clone https://github.com/nlp-compromise/de-compromise.git
cd de-compromise
npm install
npm test
npm watch
```

--------------------------------

### buildNet and match example

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/index.md

Compile match objects into an optimized `Net` with `ldv.buildNet`, then use it with `doc.match(net)`. The example matches `#Noun` and `(und|oder)` against 'Brot und Butter'.

```javascript
import ldv from 'de-compromise'
let net = ldv.buildNet([{ match: '#Noun' }, { match: '(und|oder)' }])
let doc = ldv('Brot und Butter')
doc.match(net).out('array') // ['Brot', 'und']
```

--------------------------------

### addTags example

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/index.md

Connect new tags to the tagset graph with `ldv.addTags`. The example adds a `Fantasy` tag that inherits from `Noun`.

```javascript
import ldv from 'de-compromise'
ldv.addTags({ Fantasy: { is: 'Noun' } })
```

--------------------------------

### Output methods example: text, debug, out

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Shows how to use the output methods on a View, including `out('array')` and `debug()`. The example imports the default export from 'de-compromise' and parses a German sentence.

```javascript
import ldv from 'de-compromise'
let doc = ldv('Werden wir Helden für einen Tag.')
doc.match('#Value').out('array') // ['einen']
doc.debug()                      // terminal tag dump
```

--------------------------------

### Tag method example: tag('Noun')

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Demonstrates tagging a term with a custom tag and checking with `has('#Noun')`. The example uses the `tag` method with a reason string.

```javascript
let doc = ldv('Quant ist ein Wort').tag('Noun', 'custom-word')
doc.has('#Noun') // true
```

--------------------------------

### Match example with de-compromise

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Shows how to use the `match` method with a match string and a group option. The first match returns the determiner and noun phrase, the second uses a group to extract the auxiliary-sein phrase.

```javascript
import ldv from 'de-compromise'
let doc = ldv('Die Mauer im Rücken war kalt')
doc.match('#Determiner #Noun').out('array') // ['Die Mauer']
doc.match('[{sein}] * #Participle', 0).out('array') // auxiliary-sein phrase: ['war']
```

--------------------------------

### get() usage examples

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/numbers.md

Shows get() returning [111] for a text number and [20] when selecting the first number with numbers(0).

```javascript
ldv('einhundertelf').numbers().get()   // [111]
ldv('Ich habe zwanzig Euro').numbers(0).get() // [20]
```

--------------------------------

### Numbers.get()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Gets the numeric values of the numbers in the view.

```APIDOC
## get()

### Description
Gets the numeric values of the numbers in the view.

### Returns
- **Array** - An array of numbers.
```

--------------------------------

### conjugate() usage example

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/nouns.md

Example of calling conjugate() on a German sentence, showing the returned singular/plural pairs.

```javascript
import ldv from 'de-compromise'
let doc = ldv('Die Kinder spielen im Garten')
doc.nouns().conjugate()
// [{ singular: 'kind', plural: 'kinder' },
//  { singular: 'garten', plural: 'gärten' }]
```

--------------------------------

### trim

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Removes start and end whitespace from the View. Returns a new View with trimmed whitespace.

```APIDOC
## [METHOD] trim

### Description
Removes start and end whitespace from the View. Returns a new View with trimmed whitespace.

### Method
trim

### Signature
`() => View`

### Returns
- **View** - A new View with leading and trailing whitespace removed.
```

--------------------------------

### Compute root forms with doc.compute('root')

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Imports the de-compromise library and creates a document from a German sentence. Calls compute('root') to fill in term.root for verbs/adjectives/nouns, then text('root') to get infinitive/root forms.

```javascript
import ldv from 'de-compromise'
let doc = ldv('Die Kinder waren geschwommen')
doc.compute('root') // fill in term.root for verbs/adjectives/nouns
doc.text('root')    // infinitive / root forms
```

--------------------------------

### Passing a lexicon override

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/index.md

Shows how to pass custom word tags via the lexicon parameter. The example overrides 'Kompromiss' as a ProperNoun and checks the match.

```javascript
// passing a lexicon override
import ldv from 'de-compromise'
let doc = ldv('Ich liebe Kompromiss', { Kompromiss: 'ProperNoun' })
doc.match('Kompromiss').has('#ProperNoun') // true
```

--------------------------------

### Example: conjugate() with auxiliary/modal

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/verbs.md

Shows that auxiliaries and modals are stripped before rooting. The infinitive and imperative forms are accessed from the returned object.

```javascript
// with auxiliary/modal verb phrases — the auxiliaries are stripped before rooting
let doc = ldv('ich würde schmecken')
let obj = doc.verbs().conjugate()[0]
obj.infinitive                       // 'schmecken'
obj.imperative.secondSingular        // 'schmecke'
obj.imperative.secondPlural          // 'schmeckt'
```

--------------------------------

### Example: conjugate() with past participle

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/verbs.md

Demonstrates conjugating a verb phrase with a past participle. The output shows the full conjugation object for 'schwimmen'.

```javascript
import ldv from 'de-compromise'
let doc = ldv('Die Kinder waren geschwommen')
console.log(doc.verbs().conjugate())
/*
[{
  infinitive: 'schwimmen',
  presentTense: { first: 'schwimme', second: 'schwimmst', third: 'schwimmt',
                   firstPlural: 'schwimmen', secondPlural: 'schwimmt', thirdPlural: 'schwimmen' },
  pastTense: { first: 'schwamm', ... },
  subjunctive1: { first: 'schwimme', ... },
  subjunctive2: { first: 'schwämme', ... },
  imperative: { secondSingular: 'schwimme', secondPlural: 'schwimmt' },
  pastParticiple: 'geschwommen',
  presentParticiple: 'schwimmend'
}]
*/
```

--------------------------------

### Verb root recovery examples: fromPast and fromPastParticiple

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/transforms.md

Shows how to use the verb transform methods to recover infinitives from inflected forms. `fromPast` uses a person key like 'third' to select the reverse rule, and `fromPastParticiple` falls back to a custom module when no reverse model exists.

```javascript
let v = ldv.methods().two.transform.verb
v.fromPast('schwamm', 'third')       // 'schwimmen'
v.fromPastParticiple('geschwommen') // 'schwimmen'
```

--------------------------------

### Using verb transform methods with de-compromise

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/transforms.md

Example of accessing verb transform methods via de.methods().two.transform.verb and calling toPresent, toPastParticiple, and all.

```javascript
import ldv from 'de-compromise'
let methods = ldv.methods().two.transform.verb
methods.toPresent('schwimmen')
// { first: 'schwimme', second: 'schwimmst', third: 'schwimmt', ... }
methods.toPastParticiple('schwimmen')  // 'geschwommen'
methods.all('tanzen')                  // every conjugated form, deduped
```

--------------------------------

### parseMatch without running a parse

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/index.md

Turn a match-string into an array of match objects (JSON) without running a parse. The example shows the output format for a pattern with `#Noun+` and alternatives.

```javascript
import ldv from 'de-compromise'
ldv.parseMatch('#Noun+ (und|oder) #Noun')
// [ { optional: false, ... }, ... ]
```

--------------------------------

### plugin and extend aliases

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/index.md

Mix in a compromise plugin object with `ldv.plugin` (alias `ldv.extend`). The plugin can add words and extend the View prototype; the example adds a `germanGreeting` method.

```javascript
import ldv from 'de-compromise'
ldv.plugin({
  words: { Quant: 'Noun' },
  api: function (View) {
    View.prototype.germanGreeting = function () {
      return 'Servus'
    }
  }
})
ldv('Hallo').germanGreeting() // 'Servus'
```

--------------------------------

### Get full sentence with doc.fullSentences(1).json()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Creates a document from a German sentence and retrieves the full original sentence for the second match using fullSentences(1). The .json() method outputs an object with text and terms properties.

```javascript
let doc = ldv('Hast du etwas Zeit für mich? Dann singe ich ein Lied für dich')
doc.fullSentences(1).json() // { text: 'Dann singe...', terms: [...] }
```

--------------------------------

### numbers() usage example

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/numbers.md

Shows how to call the numbers() entry point on a German sentence containing both a text number (einhunderteinundzwanzig) and a decimal number (12,5).

```javascript
import ldv from 'de-compromise'
let n = ldv('Ich habe einhunderteinundzwanzig Euro und 12,5 Prozent').numbers()
```

--------------------------------

### ldv.buildNet(match)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Builds a match net from a match expression.

```APIDOC
## buildNet(match)

### Description
Builds a match net from a match expression.

### Parameters
- **match** (string) - Required - The match expression.

### Returns
- **Net** - A compiled match net.
```

--------------------------------

### toSingular() usage example

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/nouns.md

Example of converting a plural noun to singular, showing the resulting text.

```javascript
let doc = ldv('Die Hunde bellen')
doc.nouns().toSingular().text() // 'Der Hund bellen' → 'Hund'
```

--------------------------------

### toPlural() usage example

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/nouns.md

Example of converting a singular noun to plural, showing the resulting text.

```javascript
let doc = ldv('Der Hund läuft')
doc.nouns().toPlural().text() // 'Der Hunde läuft' → 'Hunde'
```

--------------------------------

### ldv.buildTrie(words)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Builds a trie from a list of words for efficient matching.

```APIDOC
## buildTrie(words)

### Description
Builds a trie from a list of words for efficient matching.

### Parameters
- **words** (array) - Required - An array of words to build the trie from.
```

--------------------------------

### ldv.plugin(plugin)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Registers a plugin with the library, extending its functionality.

```APIDOC
## plugin(plugin)

### Description
Registers a plugin with the library, extending its functionality.

### Parameters
- **plugin** (object) - Required - The plugin object to register.
```

--------------------------------

### Verbs.conjugate()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Conjugates the verbs in the view and returns full German conjugation tables.

```APIDOC
## conjugate()

### Description
Conjugates the verbs in the view and returns full German conjugation tables.

### Returns
- **Object** - A conjugation table for each verb.
```

--------------------------------

### View.pointers()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Returns the pointers of the view.

```APIDOC
## pointers()

### Description
Returns the pointers of the view.

### Returns
- **Array** - An array of pointers.
```

--------------------------------

### slice

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Returns a subset of results. The start index is inclusive, the end index is exclusive.

```APIDOC
## slice

### Description
Returns a subset of results. The start index is inclusive, the end index is exclusive.

### Method
slice

### Signature
`(start: number, end?: number) => View`

### Parameters
- **start** (number) - Required - The start index.
- **end** (number) - Optional - The end index.

### Returns
- **View** - A new view containing the sliced results.
```

--------------------------------

### ldv.extend(fn)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Extends the View prototype with custom methods.

```APIDOC
## extend(fn)

### Description
Extends the View prototype with custom methods.

### Parameters
- **fn** (function) - Required - A function that receives the View class and adds methods to it.
```

--------------------------------

### ldv.version

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

The version of the library.

```APIDOC
## version

### Description
The version of the library.
```

--------------------------------

### ldv.TypedPlugin

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

A typed plugin helper for TypeScript users.

```APIDOC
## TypedPlugin

### Description
A typed plugin helper for TypeScript users.
```

--------------------------------

### get(n?)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/numbers.md

Returns the numeric values of matched numbers. May return null for unparseable values.

```APIDOC
## get(n?)

### Description
Returns the numeric values of matched numbers. May return null for unparseable values.

### Method
get

### Parameters
- **n** (number) - Optional - Select the nth number.

### Returns
number | number[] - The numeric values (`num` may be `null` for unparseable values).

### Example
```js
ldv('einhundertelf').numbers().get()   // [111]
ldv('Ich habe zwanzig Euro').numbers(0).get() // [20]
```
```

--------------------------------

### prepend

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Alias for `insertBefore()`. Adds words before each match in the View.

```APIDOC
## [METHOD] prepend

### Description
Alias for `insertBefore()`. Adds words before each match in the View.

### Method
prepend

### Signature
`(input: string | View) => View`

### Parameters
- **input** (string | View) - Required - The content to insert.

### Returns
- **View** - A new View with the input inserted before each match.
```

--------------------------------

### get(n?) implementation

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/numbers.md

Returns the numeric values (num) for each matched number; num may be null for unparseable values.

```javascript
get(n) {
  return getNth(this, n).map(parse).map(o => o.num)
}
```

--------------------------------

### ldv.hooks

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

The internal hooks object for compute lifecycle.

```APIDOC
## hooks

### Description
The internal hooks object for compute lifecycle.
```

--------------------------------

### nlp.version: string

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/index.md

The current semver of the library.

```APIDOC
## nlp.version: string

### Description
The current semver of the library.

### Method
`nlp.version`

### Response
Returns the version string.
```

--------------------------------

### ldv.methods

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

The internal methods object containing transformation and other utilities.

```APIDOC
## methods

### Description
The internal methods object containing transformation and other utilities.
```

--------------------------------

### nlp.plugin(plugin: Plugin): any / nlp.extend(plugin: Plugin): any

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/index.md

Mix in a compromise plugin object — `{ methods, model, compute, hooks, tags, words, lib, api, mutate }`. Both names are aliases in the core. Returns the plugin/mixed world.

```APIDOC
## nlp.plugin(plugin: Plugin): any / nlp.extend(plugin: Plugin): any

### Description
Mix in a compromise plugin object — `{ methods, model, compute, hooks, tags, words, lib, api, mutate }`. Both names are aliases in the core. Returns the plugin/mixed world.

### Method
`nlp.plugin` / `nlp.extend`

### Parameters
- `plugin` (Plugin) - Required - The plugin object to mix in.

### Request Example
```js
import ldv from 'de-compromise'
ldv.plugin({
  words: { Quant: 'Noun' },
  api: function (View) {
    View.prototype.germanGreeting = function () {
      return 'Servus'
    }
  }
})
ldv('Hallo').germanGreeting() // 'Servus'
```

### Response
Returns the plugin/mixed world.
```

--------------------------------

### View.out(method)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Outputs the view in the specified format.

```APIDOC
## out(method)

### Description
Outputs the view in the specified format.

### Parameters
- **method** (string) - Optional - The output format (e.g., 'text', 'json', 'html'). Defaults to 'text'.

### Returns
- **string|object** - The output in the requested format.
```

--------------------------------

### nlp.tokenize(text, lexicon?)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/types.md

Interprets text without tagging, providing a faster way to get a View object. Useful when part-of-speech tagging is not needed.

```APIDOC
## nlp.tokenize(text, lexicon?)

### Description
Interprets text without tagging, providing a faster way to get a View object. Useful when part-of-speech tagging is not needed.

### Method
Function

### Signature
`tokenize(text: string, lexicon?: Lexicon): View`

### Parameters
- **text** (string) - Required - The text to tokenize.
- **lexicon** (Lexicon) - Optional - Custom word definitions.

### Returns
- **View** - The tokenized view of the text.
```

--------------------------------

### methods.two.transform

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Transformation methods for verb conjugation, adjective inflection, and noun plural/singular.

```APIDOC
## methods.two.transform

### Description
Transformation methods for verb conjugation, adjective inflection, and noun plural/singular.

### Methods
- **verb** - Verb conjugation and root recovery.
- **adjective** - Adjective inflection.
- **noun** - Noun plural/singular.
- **irregulars** - Irregular table.
```

--------------------------------

### View.loop(fn)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Iterates over each term in the view and applies the function.

```APIDOC
## loop(fn)

### Description
Iterates over each term in the view and applies the function.

### Parameters
- **fn** (function) - Required - The function to apply to each term.
```

--------------------------------

### Usage example: irregular suffix handling for 'skandalös'

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/adjectives.md

Shows conjugate() output for an adjective that keeps its ending. The infinitive is 'skandalös' and suffixes are provided.

```javascript
// irregular/special suffix handling - 'skandalös' keeps its ending
let doc = ldv('skandalöser')
doc.adjectives().conjugate()
// [{ infinitive: 'skandalös', one: 'skandalöser', two: 'skandalösen', three: 'skandalöse', four: 'skandalöses' }]
```

--------------------------------

### wrap

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Produces an HTML string. Accepts a map of matches.

```APIDOC
## wrap

### Description
Produces an HTML string. Accepts a map of matches.

### Method
Function

### Signature
`(matches: object) => string`

### Parameters
- **matches** (object) - Required - A map of matches.

### Returns
- **string** - The HTML string.
```

--------------------------------

### splitBefore

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Separates everything after the match as a new phrase. Useful for splitting text at a specific point.

```APIDOC
## [METHOD] splitBefore

### Description
Separates everything after the match as a new phrase. Useful for splitting text at a specific point.

### Method
splitBefore

### Signature
`(match?: string, group?: string | number) => View`

### Parameters
- **match** (string) - Optional - The pattern to split before.
- **group** (string | number) - Optional - Group identifier.

### Returns
- **View** - A new View with the document split into phrases.
```

--------------------------------

### Usage example: conjugate() on 'eine schöne Aussicht'

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/adjectives.md

Shows the output of doc.adjectives().conjugate() for a regular adjective. Returns an array with infinitive 'schön' and suffixes.

```javascript
import ldv from 'de-compromise'
let doc = ldv('eine schöne Aussicht')
doc.adjectives().conjugate()
// [{ infinitive: 'schön', one: 'schöner', two: 'schönen', three: 'schöne', four: 'schönes' }]
```

--------------------------------

### Using a custom lexicon with de-compromise

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/configuration.md

Imports the default export and parses German text with a custom lexicon that overrides the built-in lexicon for this parse only. The example checks that the parsed document contains a Noun tag.

```javascript
import ldv from 'de-compromise'
let doc = ldv('Freibier schmeckt', { Freibier: 'Noun' })
doc.has('#Noun') // true
```

--------------------------------

### View.match(match)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Finds all matches of the given match expression in the view.

```APIDOC
## match(match)

### Description
Finds all matches of the given match expression in the view.

### Parameters
- **match** (string) - Required - The match expression.

### Returns
- **View** - A new View containing the matches.
```

--------------------------------

### nlp.model(): object

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/index.md

Grab the library's data — lexicons, tagset, regex/suffix/prefix pattern tables.

```APIDOC
## nlp.model(): object

### Description
Grab the library's data — lexicons, tagset, regex/suffix/prefix pattern tables.

### Method
`nlp.model`

### Response
Returns the model object.
```

--------------------------------

### Numbers.compare()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Compares the numbers in the view.

```APIDOC
## compare()

### Description
Compares the numbers in the view.

### Returns
- **Array** - An array of comparison results.
```

--------------------------------

### Use doc.numbers() to parse and modify German numbers

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Imports the de-compromise library and creates a document from a German sentence. Calls doc.numbers() to get a Numbers object, then applies minus(10) and outputs the modified text.

```javascript
import ldv from 'de-compromise'
let doc = ldv('Ich habe einhunderteinundzwanzig Euro')
doc.numbers().minus(10).text()
// 'Ich habe einhundertelf Euro'
```

--------------------------------

### Nouns.conjugate()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Conjugates the nouns in the view.

```APIDOC
## conjugate()

### Description
Conjugates the nouns in the view.

### Returns
- **Object** - A conjugation table for each noun.
```

--------------------------------

### post

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Adds punctuation or whitespace after each match. Returns a new View with the added content.

```APIDOC
## [METHOD] post

### Description
Adds punctuation or whitespace after each match. Returns a new View with the added content.

### Method
post

### Signature
`(str?: string, concat?: boolean) => View`

### Parameters
- **str** (string) - Optional - The string to add after each match.
- **concat** (boolean) - Optional - Whether to concatenate with existing whitespace.

### Returns
- **View** - A new View with the added content.
```

--------------------------------

### Adjective inflection and root recovery examples

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/transforms.md

Demonstrates the adjective transform methods: `toRoot` strips suffixes to the base form, `inflect` returns the four declension forms, and `all` returns all inflected forms as an array. The `inflect` method uses a greedy suffix model with a default fallback.

```javascript
let adj = ldv.methods().two.transform.adjective
adj.toRoot('schöner')            // 'schön'
adj.inflect('schön')
// { one: 'schöner', two: 'schönen', three: 'schöne', four: 'schönes' }
adj.all('skandalös')             // ['skandalöser', 'skandalösen', 'skandalöse', 'skandalöses']
```

--------------------------------

### Nouns.toPlural()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Converts the nouns in the view to plural form.

```APIDOC
## toPlural()

### Description
Converts the nouns in the view to plural form.

### Returns
- **View** - A new View with plural nouns.
```

--------------------------------

### Nouns.toSingular()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Converts the nouns in the view to singular form.

```APIDOC
## toSingular()

### Description
Converts the nouns in the view to singular form.

### Returns
- **View** - A new View with singular nouns.
```

--------------------------------

### ldv.addTags(tags)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Adds custom tags to the tagset.

```APIDOC
## addTags(tags)

### Description
Adds custom tags to the tagset.

### Parameters
- **tags** (object) - Required - An object mapping tag names to tag definitions.
```

--------------------------------

### Numbers.toText()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Converts the numbers in the view to text representation.

```APIDOC
## toText()

### Description
Converts the numbers in the view to text representation.

### Returns
- **View** - A new View with numbers as text.
```

--------------------------------

### ldv.addWords(words)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Adds custom words to the lexicon.

```APIDOC
## addWords(words)

### Description
Adds custom words to the lexicon.

### Parameters
- **words** (object) - Required - An object mapping words to their tags.
```

--------------------------------

### ldv.typeahead(input)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Provides typeahead suggestions based on the input.

```APIDOC
## typeahead(input)

### Description
Provides typeahead suggestions based on the input.

### Parameters
- **input** (string) - Required - The input text.

### Returns
- **Array** - An array of suggestion strings.
```

--------------------------------

### View.cache()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Caches the view for faster subsequent operations.

```APIDOC
## cache()

### Description
Caches the view for faster subsequent operations.
```

--------------------------------

### toParentheses

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Wraps the View in parentheses. Returns a new View with the added parentheses.

```APIDOC
## [METHOD] toParentheses

### Description
Wraps the View in parentheses. Returns a new View with the added parentheses.

### Method
toParentheses

### Signature
`(start?: string, end?: string) => View`

### Parameters
- **start** (string) - Optional - The starting parenthesis.
- **end** (string) - Optional - The ending parenthesis.

### Returns
- **View** - A new View wrapped in parentheses.
```

--------------------------------

### pre

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Adds punctuation or whitespace before each match. Returns a new View with the added content.

```APIDOC
## [METHOD] pre

### Description
Adds punctuation or whitespace before each match. Returns a new View with the added content.

### Method
pre

### Signature
`(str?: string, concat?: boolean) => View`

### Parameters
- **str** (string) - Optional - The string to add before each match.
- **concat** (boolean) - Optional - Whether to concatenate with existing whitespace.

### Returns
- **View** - A new View with the added content.
```

--------------------------------

### out

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Produces output in a named format. Accepts an optional format string from the supported list.

```APIDOC
## out

### Description
Produces output in a named format. Accepts an optional format string from the supported list.

### Method
Function

### Signature
`(format?: outMethods) => any`

### Parameters
- **format** (outMethods) - Optional - Named output format: 'text', 'normal', 'offset', 'terms', 'topk', 'json', 'tags', 'array', 'debug'.

### Returns
- **any** - The output in the specified format.
```

--------------------------------

### insertBefore

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Adds words before each match in the View. Returns a new View with the inserted content.

```APIDOC
## [METHOD] insertBefore

### Description
Adds words before each match in the View. Returns a new View with the inserted content.

### Method
insertBefore

### Signature
`(input: string | View) => View`

### Parameters
- **input** (string | View) - Required - The content to insert.

### Returns
- **View** - A new View with the input inserted before each match.
```

--------------------------------

### nlp.buildNet(matches: Match[]): Net

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/index.md

Compile a sequence of match objects into an optimized `Net`, for use with `doc.match(net)` / `doc.sweep(net)`.

```APIDOC
## nlp.buildNet(matches: Match[]): Net

### Description
Compile a sequence of match objects into an optimized `Net`, for use with `doc.match(net)` / `doc.sweep(net)`.

### Method
`nlp.buildNet`

### Parameters
- `matches` (Match[]) - Required - The match objects to compile.

### Request Example
```js
import ldv from 'de-compromise'
let net = ldv.buildNet([{ match: '#Noun' }, { match: '(und|oder)' }])
let doc = ldv('Brot und Butter')
doc.match(net).out('array') // ['Brot', 'und']
```

### Response
Returns a Net object.
```

--------------------------------

### Tokenizer plugin configuration (plugin.js)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/plugins.md

Exports the tokenizer plugin configuration that mutates the world model with unicode, contractions, and sentence detection methods. Sets world.model.one.unicode, world.model.one.contractions, and world.methods.one.tokenize.isSentence.

```javascript
export default {
  mutate: (world) => {
    world.model.one.unicode = unicode
    world.model.one.contractions = contractions
    world.methods.one.tokenize.isSentence = isSentence
  },
}
```

--------------------------------

### ldv.world

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

The internal world object containing models and methods.

```APIDOC
## world

### Description
The internal world object containing models and methods. Accessible for advanced customization.
```

--------------------------------

### Root compute excerpt (src/01-one/lexicon/compute/root.js)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/plugins.md

Sets term.root for verbs based on tags, choosing the appropriate reverse model (e.g., fromPresentParticiple, fromPastParticiple, fromPresent). The excerpt shows the conditional logic for verb forms.

```javascript
// src/01-one/lexicon/compute/root.js
if (term.tags.has('Verb')) {
  let form = verbForm(term)
  if (term.tags.has('Participle') && term.tags.has('PresentTense')) {
    term.root = verb.fromPresentParticiple(str, form)
  } else if (term.tags.has('Participle') && term.tags.has('PastTense')) {
    term.root = verb.fromPastParticiple(str, form)
  } else if (term.tags.has('PresentTense')) {
    term.root = verb.fromPresent(str, form)
  } ...
}
```

--------------------------------

### toQuotations

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Wraps the View in quotation marks. Returns a new View with the added quotation marks.

```APIDOC
## [METHOD] toQuotations

### Description
Wraps the View in quotation marks. Returns a new View with the added quotation marks.

### Method
toQuotations

### Signature
`(start?: string, end?: string) => View`

### Parameters
- **start** (string) - Optional - The starting quotation mark.
- **end** (string) - Optional - The ending quotation mark.

### Returns
- **View** - A new View wrapped in quotation marks.
```

--------------------------------

### ldv.tokenize(text)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Tokenizes the input text into an array of tokens without full parsing.

```APIDOC
## tokenize(text)

### Description
Tokenizes the input text into an array of tokens without full parsing.

### Parameters
- **text** (string) - Required - The text to tokenize.

### Returns
- **Array** - An array of token strings.
```

--------------------------------

### replace

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Searches for the given pattern and replaces it with the provided replacement. Returns a new View with the replacements applied.

```APIDOC
## [METHOD] replace

### Description
Searches for the given pattern and replaces it with the provided replacement. Returns a new View with the replacements applied.

### Method
replace

### Signature
`(from: string | View, to?: string | Function, keep?: object) => View`

### Parameters
- **from** (string | View) - Required - The pattern to search for.
- **to** (string | Function) - Optional - The replacement content or function.
- **keep** (object) - Optional - Options for keeping certain properties.

### Returns
- **View** - A new View with the replacements applied.
```

--------------------------------

### forEach

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Runs a function on each phrase as an individual document. The function receives a view for each phrase.

```APIDOC
## forEach

### Description
Runs a function on each phrase as an individual document. The function receives a view for each phrase.

### Method
forEach

### Signature
`(fn: (m: View) => void) => View`

### Parameters
- **fn** (function) - Required - The function to run on each phrase.

### Returns
- **View** - The original view object.
```

--------------------------------

### nlp.world(): object

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/index.md

Grab library internals — the `world` object holding `methods`, `model`, `compute`, `hooks`.

```APIDOC
## nlp.world(): object

### Description
Grab library internals — the `world` object holding `methods`, `model`, `compute`, `hooks`.

### Method
`nlp.world`

### Response
Returns the world object.
```

--------------------------------

### ldv.lazy(text)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Creates a lazy parse of the text, deferring computation until needed.

```APIDOC
## lazy(text)

### Description
Creates a lazy parse of the text, deferring computation until needed.

### Parameters
- **text** (string) - Required - The text to parse lazily.

### Returns
- **View** - A View object that computes on demand.
```

--------------------------------

### matchOne

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Returns a View containing only the first match of the given pattern. Useful when you only need the first occurrence.

```APIDOC
## [METHOD] matchOne

### Description
Returns a View containing only the first match of the given pattern. Useful when you only need the first occurrence.

### Method
matchOne

### Signature
`(match: string | View | Net, group?: string | number, options?: matchOptions) => View`

### Parameters
- **match** (string | View | Net) - Required - The pattern to match.
- **group** (string | number) - Optional - Group identifier.
- **options** (matchOptions) - Optional - Additional matching options.

### Returns
- **View** - A View containing the first match only.
```

--------------------------------

### all

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Returns the whole original document, effectively zooming out from the current view.

```APIDOC
## all

### Description
Returns the whole original document, effectively zooming out from the current view.

### Method
all

### Signature
`() => View`

### Returns
- **View** - The entire document.
```

--------------------------------

### View.tag(tags)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Tags the terms in the view with the given tags.

```APIDOC
## tag(tags)

### Description
Tags the terms in the view with the given tags.

### Parameters
- **tags** (string|array) - Required - The tag or tags to apply.
```

--------------------------------

### html

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Produces an HTML string. Accepts a map of matches to highlight.

```APIDOC
## html

### Description
Produces an HTML string. Accepts a map of matches to highlight.

### Method
Function

### Signature
`(toHighlight: object) => string`

### Parameters
- **toHighlight** (object) - Required - A map of matches, e.g., `{ nouns: doc.match('#Noun'), ... }`.

### Returns
- **string** - The HTML string.
```

--------------------------------

### ldv.parseMatch(match)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Parses a match expression into a Net object for use in matching.

```APIDOC
## parseMatch(match)

### Description
Parses a match expression into a Net object for use in matching.

### Parameters
- **match** (string) - Required - The match expression to parse.

### Returns
- **Net** - A compiled match net.
```

--------------------------------

### firstTerms

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Returns the first word of each match.

```APIDOC
## firstTerms

### Description
Returns the first word of each match.

### Method
firstTerms

### Signature
`() => View`

### Returns
- **View** - A new view containing the first terms.
```

--------------------------------

### View.insert(text)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Inserts text into the view at the current position.

```APIDOC
## insert(text)

### Description
Inserts text into the view at the current position.

### Parameters
- **text** (string) - Required - The text to insert.
```

--------------------------------

### numbers(n?) entry point implementation

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/numbers.md

Entry point that matches #Value+ terms, keeps multi-word numbers containing million/millionen/milliarde whole, otherwise reduces to single terms. Forces the splitter compute so text values like einhunderteinundzwanzig can be split into parseable pieces (term.splits). Returns a Numbers view.

```javascript
View.prototype.numbers = function (n) {
  let m = this.match('#Value+')
  if (!m.has('(million|millionen|milliarde)')) {
    m = m.terms()
  }
  m.compute('splitter')   // make sure splitter has run
  m = getNth(m, n)
  return new Numbers(this.document, m.pointer)
}
```

--------------------------------

### Numbers.parse()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Parses the numbers in the view.

```APIDOC
## parse()

### Description
Parses the numbers in the view.

### Returns
- **Array** - An array of parsed number objects.
```

--------------------------------

### ldv.verbose(flags)

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Enables or disables verbose logging for debugging.

```APIDOC
## verbose(flags)

### Description
Enables or disables verbose logging for debugging.

### Parameters
- **flags** (object) - Optional - An object with boolean flags like DEBUG_TAGS, DEBUG_MATCH, DEBUG_CHUNKS.
```

--------------------------------

### nlp.verbose(toLog?: boolean | string): any

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/index.md

Log the tagger's decision-making to the console. Wrapper defined locally in `src/index.js`.

```APIDOC
## nlp.verbose(toLog?: boolean | string): any

### Description
Log the tagger's decision-making to the console. Wrapper defined locally in `src/index.js`.

### Method
`nlp.verbose`

### Parameters
- `toLog` (boolean | string) - Optional - What to log. `true` enables all, `'tagger'` enables tagger, `'match'` enables match, `'chunker'` enables chunker, falsy clears all.

### Response
Returns `this` (chainable).
```

--------------------------------

### Numbers.toCardinal()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Converts the numbers in the view to cardinal form.

```APIDOC
## toCardinal()

### Description
Converts the numbers in the view to cardinal form.

### Returns
- **View** - A new View with cardinal numbers.
```

--------------------------------

### replaceWith

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Substitutes new content into the View. Returns a new View with the substituted content.

```APIDOC
## [METHOD] replaceWith

### Description
Substitutes new content into the View. Returns a new View with the substituted content.

### Method
replaceWith

### Signature
`(to: string | Function, keep?: object) => View`

### Parameters
- **to** (string | Function) - Required - The replacement content or function.
- **keep** (object) - Optional - Options for keeping certain properties.

### Returns
- **View** - A new View with the substituted content.
```

--------------------------------

### before

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Returns a View containing the terms that appear before each match. Useful for extracting context.

```APIDOC
## [METHOD] before

### Description
Returns a View containing the terms that appear before each match. Useful for extracting context.

### Method
before

### Signature
`(match: string | View, group?: string | number, options?: matchOptions) => View`

### Parameters
- **match** (string | View) - Required - The pattern to match.
- **group** (string | number) - Optional - Group identifier.
- **options** (matchOptions) - Optional - Additional matching options.

### Returns
- **View** - A View containing the terms before each match.
```

--------------------------------

### ldv._world

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

The internal world object (alias for world).

```APIDOC
## _world

### Description
The internal world object (alias for world).
```

--------------------------------

### split

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Alias for `splitAfter()`. Splits the document into phrases based on the given match.

```APIDOC
## [METHOD] split

### Description
Alias for `splitAfter()`. Splits the document into phrases based on the given match.

### Method
split

### Signature
`(match?: string, group?: string | number) => View`

### Parameters
- **match** (string) - Optional - The pattern to split on.
- **group** (string | number) - Optional - Group identifier.

### Returns
- **View** - A new View with the document split into phrases.
```

--------------------------------

### complement

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Returns everything that is not a match. Accepts a match string or View.

```APIDOC
## complement

### Description
Returns everything that is not a match. Accepts a match string or View.

### Method
Function

### Signature
`(match: string | View) => View`

### Parameters
- **match** (string | View) - Required - The match pattern or View.

### Returns
- **View** - The resulting view.
```

--------------------------------

### Nouns.isPlural()

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/README.md

Checks if the nouns in the view are plural.

```APIDOC
## isPlural()

### Description
Checks if the nouns in the view are plural.

### Returns
- **boolean** - True if all nouns are plural, false otherwise.
```

--------------------------------

### not

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Returns everything except the given match. Accepts a match string or View and optional options.

```APIDOC
## not

### Description
Returns everything except the given match. Accepts a match string or View and optional options.

### Method
Function

### Signature
`(match: string | View, options?: any) => View`

### Parameters
- **match** (string | View) - Required - The match pattern or View.
- **options** (any) - Optional - Additional options.

### Returns
- **View** - The resulting view.
```

--------------------------------

### autoFill

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Assumes any type-ahead prefixes (from `nlp.typeahead`).

```APIDOC
## autoFill

### Description
Assumes any type-ahead prefixes (from `nlp.typeahead`).

### Method
Function

### Signature
`() => View`

### Returns
- **View** - The resulting view.
```

--------------------------------

### match

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Returns a new View containing all terms that match the given pattern. The match can be a string, another View, or a compiled Net.

```APIDOC
## [METHOD] match

### Description
Returns a new View containing all terms that match the given pattern. The match can be a string, another View, or a compiled Net.

### Method
match

### Signature
`(match: string | View | Net, group?: string | number, options?: matchOptions) => View`

### Parameters
- **match** (string | View | Net) - Required - The pattern to match.
- **group** (string | number) - Optional - Group identifier.
- **options** (matchOptions) - Optional - Additional matching options.

### Returns
- **View** - A new View containing the matched terms.

### Example
```js
import ldv from 'de-compromise'
let doc = ldv('Die Mauer im Rücken war kalt')
doc.match('#Determiner #Noun').out('array') // ['Die Mauer']
```
```

--------------------------------

### debug

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Pretty-prints the document and its tags to the console. Returns the View for chaining.

```APIDOC
## debug

### Description
Pretty-prints the document and its tags to the console. Returns the View for chaining.

### Method
Function

### Signature
`() => View`

### Returns
- **View** - The current view.
```

--------------------------------

### none

Source: https://github.com/nlp-compromise/de-compromise/blob/main/_autodocs/api-reference/view.md

Returns an empty view. This is useful for initializing a view with no results.

```APIDOC
## none

### Description
Returns an empty view. This is useful for initializing a view with no results.

### Method
none

### Signature
`() => View`

### Returns
- **View** - An empty view.
```
Tokens:
Raw