Class BooleanGambitAbstract

constructor

• new BooleanGambit(): BooleanGambit

  Returns BooleanGambit

predicates

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

type

booleanKey

• booleanKey(): "is" | "has" | "allows"

  Returns "is" | "has" | "allows"

enabled

• enabled(): boolean

  Whether this gambit can be used by the actor.

  Returns boolean

AbstractfilterKey

• filterKey(): string

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

  Returns string

fromFilter

• fromFilter(value: string, negate: boolean): string

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

  Parameters

  • value: string
  • negate: boolean

  Returns string

groupKey

• groupKey(): string

  Returns string

Abstractkey

• key(): string | string[]

  Returns string | 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(): { group: string; key: string | string[] }

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

  Returns { group: string; key: string | string[] }

toFilter

• toFilter(_matches: string[], negate: boolean): Record<string, any>

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

  Parameters

  • _matches: string[]
  • negate: boolean

  Returns Record<string, any>