Class KeyValueGambitAbstract

Hierarchy

Implements

Constructors

Properties

predicates: boolean = false

Whether this gambit can use logical operators. For example, the tag gambit can be used as such: tag:foo,bar tag:baz which translates to (foo OR bar) AND baz.

The info allows generation of the correct filtering format, which would be

{
tag: [
'foo,bar', // OR because of the comma.
'baz', // AND because it's a separate item.
]
}

The backend filter must be able to handle this format. Checkout the TagGambit and TagFilter classes for an example.

type: GambitType = GambitType.KeyValue

Methods

  • This is the regular expression pattern that will be used to match the gambit. The pattern language can be localized. for example, the pattern for the author gambit is author:(.+) in English, but auteur:(.+) in French.

    Returns string

  • This returns information about how the gambit is structured for the UI. Use localized values.

    Returns {
        hint: string;
        key: string;
    }

    • hint: string
    • key: string

Generated using TypeDoc v0.24.8