Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FilteredRefinementList<S, A, S, A>

Type parameters

  • S: object

  • A: object

  • S: object

  • A: object

Hierarchy

Index

Interfaces

Type aliases

Properties

Accessors

Methods

Object literals

Type aliases

Static Refinement

Refinement: Refinement & object

Properties

_consumes

_consumes: string[]

_eventHandlers

_eventHandlers: [string, function][]

_lookups

_lookups: [string[], function][]

_provides

_provides: Record<string, function>

_removeEventHandlers

_removeEventHandlers: function

Type declaration

    • (): void

    • Returns void

_removeLookups

_removeLookups: function

Type declaration

    • (): void

    • Returns void

isInitialized

isInitialized: boolean

state

state: S

Accessors

alias

  • get alias(): string

Methods

consume

  • consume(alias: string): void

  • Parameters

    • alias: string

    Returns void

dispatch

  • dispatch(action: Action<string, any>): void

  • Parameters

    • action: Action<string, any>

    Returns void

init

  • init(): void

provide

  • provide(alias: string, resolve?: function): void

  • Parameters

    • alias: string
    • Optional resolve: function
        • (props: Props, state: S, aliases: A): void

        • Parameters

          • props: Props
          • state: S
          • aliases: A

          Returns void

    Returns void

select

  • select(selector: function, ...args: any[]): any

  • Parameters

    • selector: function
        • (state: State, ...args: any[]): any

        • Parameters

          • state: State
          • Rest ...args: any[]

          Returns any

    • Rest ...args: any[]

    Returns any

set

  • set(state: Partial<S> | true): void

  • Parameters

    • state: Partial<S> | true

    Returns void

subscribe

  • subscribe<T>(event: string, handler: function): void

  • Invoke the callback provided each time the target event is emitted.

    All callbacks are automatically removed when the component is unmounted.

    Type parameters

    • T

    Parameters

    • event: string
    • handler: function
        • (data?: T): void

        • Parameters

          • Optional data: T

          Returns void

    Returns void

subscribeOnce

  • subscribeOnce(event: string, handler: function): void

  • Invoke the callback provided the next time the target event is emitted, then unregister it.

    Parameters

    • event: string
    • handler: function
        • (event: string, data?: any): void

        • Parameters

          • event: string
          • Optional data: any

          Returns void

    Returns void

subscribeWith

  • subscribeWith<T>(events: string[], handler: function): void

  • Invoke the callback provided each time the member events have been emitted at least once.

    All callbacks are automatically removed when the component is unmounted.

    Type parameters

    • T

    Parameters

    • events: string[]
    • handler: function
        • (data?: T): void

        • Parameters

          • Optional data: T

          Returns void

    Returns void

Object literals

props

props: object

itemProps

itemProps: object

Type declaration

refinements

refinements: undefined[] = []

Generated using TypeDoc