Class GambitManager

The gambit registry. A map of resource types to gambit classes that should be used to filter resources of that type. Gambits are automatically converted to API filters when requesting resources. Gambits must be applied on a filter object that has a q property containing the search query.

Hierarchy

GambitManager

Index

Constructors

constructor

new GambitManager(): GambitManager
Returns GambitManager

Properties

gambits

gambits: Record<string, (new () => IGambit<GambitType>)[]> = ...

Methods

apply

apply(type, filter): Record<string, any>
Parameters
- type: string
- filter: Record<string, any>
Returns Record<string, any>
- Defined in framework/core/js/src/common/GambitManager.ts:21

for

for(type): IGambit<GambitType>[]
Parameters
- type: string
Returns IGambit<GambitType>[]
- Defined in framework/core/js/src/common/GambitManager.ts:86

from

from(type, q, filter): string
Parameters
- type: string
- q: string
- filter: Record<string, any>
Returns string
- Defined in framework/core/js/src/common/GambitManager.ts:66

match

match(type, query, onmatch): string
Parameters
- type: string
- query: string
- onmatch: ((gambit, matches, negate, bit) => void)
  - - (gambit, matches, negate, bit): void
    - Parameters
      
      gambit: IGambit<GambitType>
      
      matches: string[]
      
      negate: boolean
      
      bit: string
      
      Returns void
Returns string
- Defined in framework/core/js/src/common/GambitManager.ts:37

Class GambitManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns GambitManager

Properties

gambits

Methods

apply

Parameters

type: string

filter: Record<string, any>

Returns Record<string, any>

for

Parameters

type: string

Returns IGambit<GambitType>[]

from

Parameters

type: string

q: string

filter: Record<string, any>

Returns string

match

Parameters

type: string

query: string

onmatch: ((gambit, matches, negate, bit) => void)

Parameters

gambit: IGambit<GambitType>

matches: string[]

negate: boolean

bit: string

Returns void

Returns string

Settings

Member Visibility

Theme

On This Page