Interface IGambit<Type>

predicates

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

type

enabled

• enabled(): boolean

• Whether this gambit can be used by the actor.

  Returns boolean

filterKey

• filterKey(): string

• This is the server standardised filter key for this gambit. The filter key must not be localized.

  Returns string

fromFilter

• fromFilter(value, negate): string

• This is the method to transform a filter into a gambit format. The gambit format can be localized.

  Parameters

  • value: any

  • negate: boolean

  Returns string

pattern

• pattern(): string

• 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

suggestion

• suggestion(): Type extends KeyValue
      ? KeyValueGambitSuggestion
      : GroupedGambitSuggestion

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

  Returns Type extends KeyValue
      ? KeyValueGambitSuggestion
      : GroupedGambitSuggestion

toFilter

• toFilter(matches, negate): Record<string, any>

• This is the method to transform a gambit into a filter format.

  Parameters

  • matches: string[]

  • negate: boolean

  Returns Record<string, any>