Class KeyValueGambitAbstract

constructor

• new KeyValueGambit(): KeyValueGambit

• Returns KeyValueGambit

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

Abstract filterKey

• filterKey(): string

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

  Returns string

filterValueToGambitValue

• filterValueToGambitValue(value): string

• Parameters

  • value: any

  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

gambitValueToFilterValue

• gambitValueToFilterValue(value): string | number | boolean | any[]

• Parameters

  • value: string

  Returns string | number | boolean | any[]

Abstract hint

• hint(): string

• Returns string

Abstract key

• key(): string

• 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(): {
      hint: string;
      key: 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

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>

valuePattern

• valuePattern(): string

• Returns string