CharacterFilter

Abstract base class for implementing custom character filters.

Import

import CharacterFilter from 'dynamosearch/char_filters/CharacterFilter';

Type Definition

abstract class CharacterFilter {
  abstract apply(str: string): string;
}

Implementing a Custom Character Filter

To create a custom character filter, extend the CharacterFilter class and implement the apply method:

import CharacterFilter from 'dynamosearch/char_filters/CharacterFilter';

class MyCustomCharFilter extends CharacterFilter {
  apply(str: string): string {
    // Your transformation logic here
    return transformedString;
  }
}

Example

class UpperCaseCharFilter extends CharacterFilter {
  apply(str: string): string {
    return str.toUpperCase();
  }
}

const filter = new UpperCaseCharFilter();
const result = filter.apply('hello world');
// 'HELLO WORLD'

See Also

• ICUNormalizer
• Analyzer